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

Property

Typical value

Type

Required

Description

CardType

1

N(1)

YES

 

PAN

Byte[]

BASE64

YES

 

CardholderName

John Smith

String (30)

YES

 

ExpDate

Byte[]

BASE64

YES

 

CVC

Byte[]

BASE64

YES

 

ECI

6

N(1)

YES

 

AVV

Byte[]

BASE64

Conditional

Conditional.

AVV is required when the card is 3DS enabled.

XID

Byte[]

BASE64

Conditional

Conditional.

AVV is required when the card is 3DS enabled.

CardVerification

2

N(2)

YES

Specify whether the inputted card data to be verified or not before storing. Please refer to Card Verification.

Amount

3.50

Double

Conditional

Conditional. Amount of the transaction. Used in the request if CardVerification = 2.

Currency

EUR

A(3)

Conditional

Conditional. ISO 3-character currency code. Used in the request if CardVerification = 2.

OutputFormat

xml

String

NO

Output format of data. The property can be “xml” or “json”. If it is not specified in the request, the default value is “xml”.

 

Response properties

Property

Typical value

Type

Description

CardToken

1041333312721BC752C1AB7743D0821AA1C9CA09

String (50)

Uniquely generated token of the PAN of the card (returned as a response property of IPCIAPurchase).

PAN

4885

N(4)

Last four digits of the account number (PAN).

ExpDate

1703

N(4)

Card's expiry date. Format YYMM.

CardType

1

N(1)

Please refer to Card Types.

Trn_ref

4798689

N(7)

Transaction reference

 

Example of the xml response

<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>