In-App Store Card

Securely Store a Customer's Card for Future Use

Purpose

This method is used by myPOS Checkout API to allow the cardholder to securely store card data which will be used for recurring payments or pre-authorizations afterwards. The cardholder will remain within the pages of the external application. The Merchant has to be PCI SAQ-D compliant and process the card details. All needed data (incl. payment card details) will be collected and submitted to myPOS Checkout API by the external app. The myPOS Checkout API will return an XML/JSON with the result.

Method Properties

PropertyTypical ValueTypeRequiredDescription
CardType1N(1)YESRefer to myPOS Card Types
PANByte[]BASE64YESCard Number (Base64 encoded)
CardholderNameJohn SmithString (30)YESFull name as shown on the card
ExpDateByte[]BASE64YESExpiry date in MMYY format (Base64 encoded)
CVCByte[]BASE64YESCard verification code (Base64 encoded)
ECI6N(1)YESElectronic Commerce Indicator
AVVByte[]BASE64ConditionalRequired when the card is 3DS enabled
XIDByte[]BASE64ConditionalRequired when the card is 3DS enabled
CardVerification2N(2)YESSpecify whether the inputted card data to be verified or not before storing.
Amount3.50DoubleConditionalAmount of the transaction. Used if CardVerification = 2.
CurrencyEURA(3)ConditionalISO 3-character currency code. Used if CardVerification = 2.
OutputFormatxmlStringNOOutput format of data. Can be “xml” or “json”. Default is “xml”.

Partner Identification

If you are part of our Partners Program, you will need to submit these two additional parameters with each of your requests to the API. This will provide you with analytics about the usage in your myPOS Partners Portal account and help our support teams assist you better.

This requires you to set the API version of your requests to 1.4.1. No other changes in the code/requests are necessary.

PropertyTypical ValueTypeDescription
PartnerIDmps-p-XXXXXXXXStringIdentical number for the partner
ApplicationIDmps-app-XXXXXXXXStringIdentical number for the application

Response Properties

PropertyTypical ValueTypeDescription
CardToken1041333312721BC752C1AB7743D0821AA1C9CA09String (50)Uniquely generated token of the PAN of the card
PAN4885N(4)Last four digits of the account number (PAN)
ExpDate1703N(4)Card's expiry date. Format YYMM
CardType1N(1)Refer to Card Types
Trn_ref4798689N(7)Transaction reference

Important Notes

  • You must be PCI SAQ-D compliant to use this method, as you're handling raw card data.
  • For 3D Secure cards, AVV and XID must be provided.
  • If you're not PCI certified, consider using IPCPurchase with CardTokenRequest = 1 to tokenize the card instead.

Example Request

<IPC_response>
    <IPCmethod>IPCIAStoreCard</IPCmethod>
    <CardToken>70b2214c43814a99f66266c1f1f1e5ec4a8e2a01</CardToken>
    <PAN>4885</PAN>
    <ExpDate>1703</ExpDate>
    <CardType>1</CardType>
    <Trn_ref>4798689</Trn_ref>
    <Status>0</Status>
    <StatusMsg>Success</StatusMsg>   
</IPC_response>