cardRequest

The cardRequest object allows to transmit information related to the payment card.

Depending on the payment type (payment by token or payment by form, when the buyer enters the payment method details manually), one or several attributes are required.

  • Payment with card data entry:
Table 1. cardRequest object
cardRequest
Attribute Required Format
number

Card number.

requires subscription to the service "Access to acquisition on the merchant website via SOAP Web Services"

string
scheme

Type of card selected by the buyer.

Examples of possible values: , MASTERCARD, VISA, VISA_ELECTRON, VPAY, MAESTRO,JCB.

For more information, see the List of supported card types.

string
expiryMonth

Card expiration month, between 1 and 12.

n..2
expiryYear

Card expiry year in 4 digits.

Example: 2016

n4
cardSecurityCode

Card Security Code code in 3 digits (or 4 for Amex).

This field is mandatory if the card has a Card Security Code. If the Card Security Code is not transmitted, the issuing bank will refuse the payment.

However, this parameter is optional when the source of the transaction is set to MOTO

  string
cardHolderBirthday

Cardholder's birth date in the YYYY-MM-DD format.

Required depending on the payment method dateTime ans..64
cardHolderName

Cardholder's name.

This field corresponds to the name of the cardholder.

Mandatory for DECIDIR and VISANET, acquirers from South America.

Required depending on the payment method string
proofOfIdType

Type of ID.

Possible values:

  • DNI (= Documento Nacional de Identidad) Mandatory for DECIDIR.
Required depending on the payment method string
proofOfIdNumber

ID number.

Corresponds to the number of the selected ID type. Example: 2AZ265480.

The format depends on the ID type and allows 7 to 13 characters, digits, letters and/or dots.

Required for DECIDIR.

Required depending on the payment method an..13
walletPayload

Allows to transmit a payload encrypted during payment by wallet (ApplePay, GooglePay, etc.).

Requires subscription to the service "Transmission of encrypted payment data (Payload) by SOAP Web Services".

  json
  • Payment using an existing token:
Table 2. cardRequest object
cardRequest
Attribute Required Format
paymentToken

Unique identifier (token) associated to a payment method.

  • it can either be generated by the payment gateway.
  • or by the merchant website.

Requires subscription to the service "Payment by token".

string ans..64
cardSecurityCode

Card Security Code code in 3 digits (or 4 for Amex).

To ensure the payment, merchant must request to the buyer:

  • card security code entry
  • 3D Secure authentication
  string ans..64

Note:

In order for a payment using an existing token (one-click payment) to be guaranteed, the merchant must ask the buyer for:
  • card security code entry
  • 3D Secure authentication