Skip to main content

PaymentCardInput

PaymentCardInput contains payment card information supplied by the client.

typetype (string)

Card type as recognised by providers.

Possible values: [AX, BC, CA, CB, CU, DC, DS, E, EC, ER, EU, JC, L, N, O, OP, R, S, T, TO, TP, VI, XS]

holder object

Card holder information.

namename (string)

Holder given name.

surnamesurname (string)

Holder family name.

titletitle (string)

Courtesy title for the holder.

Possible values: [MR, MRS, MISS, MS, NOT_SPECIFIED]

contactInfo object

Contact details for the holder.

emailemail (string)

Primary email address that providers can use for notifications.

phone object

Traveller phone information for confirmations or alerts.

countryCodecountryCode (string)

International country dialling prefix without the plus sign.

numbernumber (string)

Subscriber number excluding the country code.

addressaddress (string)

Street address of the contact person.

citycity (string)

City associated with the contact address.

countrycountry (string)

Country ISO code associated with the contact address.

postalCodepostalCode (string)

Postal or ZIP code associated with the contact address.

numbernumber (string)

Card number with no separators.

CVCCVC (string)

Card verification code.

expire object

Card expiry details.

monthinteger<int32>

Expiry month expressed from 1 to 12.

yearinteger<int32>

Expiry year expressed with four digits.

isVCCisVCC (boolean)

Indicates whether the card is virtual.

virtualCreditCard object

Additional details for virtual credit cards.

activationDatestring<date-time>

Activation timestamp for the virtual card.

deactivationDatestring<date-time>

Deactivation timestamp for the virtual card.

currentBalancenumber<double>

Current available balance.

currencyCodecurrencyCode (string)

ISO 4217 currency code for the balance.

threeDomainSecurity object

3DS authentication data captured during payment.

versionversion (string)

3DS version used during authentication.

DSTransactionIDDSTransactionID (string)

Directory server transaction identifier.

XIDXID (string)

Transaction identifier (XID).

ECIECI (string)

Electronic commerce indicator.

CAVVCAVV (string)

Cardholder authentication verification value.

payerResponsepayerResponse (string)

Raw payer response returned by the authentication system.

payerResponseStatuspayerResponseStatus (string)

Parsed status for the payer response.

Possible values: [AUTHENTICATION_SUCCESS, AUTHENTICATION_FAILED, AUTHENTICATION_INCOMPLETE, TRANSACTION_ATTEMPT_SUCCESS_A, TRANSACTION_ATTEMPT_SUCCESS_B, AUTHENTICATION_REJECTED]

cardEnrolledStatuscardEnrolledStatus (string)

Enrolment status of the card in 3DS.

Possible values: [CARD_ENROLLED, CARD_NOT_ENROLLED, CANT_AUTHENTICATE]

merchantNamemerchantName (string)

Merchant name presented during authentication.

signatureStatussignatureStatus (string)

Signature validation result.

Possible values: [SIGNATURE_VALIDATED, SIGNATURE_NOT_VALIDATED]

PaymentCardInput
{
"type": "AX",
"holder": {
"name": "string",
"surname": "string",
"title": "MR",
"contactInfo": {
"email": "string",
"phone": {
"countryCode": "string",
"number": "string"
},
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string"
}
},
"number": "string",
"CVC": "string",
"expire": {
"month": 0,
"year": 0
},
"isVCC": true,
"virtualCreditCard": {
"activationDate": "2024-07-29T15:51:28.071Z",
"deactivationDate": "2024-07-29T15:51:28.071Z",
"currentBalance": 0,
"currencyCode": "string"
},
"threeDomainSecurity": {
"version": "string",
"DSTransactionID": "string",
"XID": "string",
"ECI": "string",
"CAVV": "string",
"payerResponse": "string",
"payerResponseStatus": "AUTHENTICATION_SUCCESS",
"cardEnrolledStatus": "CARD_ENROLLED",
"merchantName": "string",
"signatureStatus": "SIGNATURE_VALIDATED"
}
}