On This Page
REST API
Request Fields
The
consumerAuthenticationInformation.referenceId
field is mapped from the consumerAuthenticationInformation.referenceId
field as discussed in Step 1: Setup Service.consumerAuthenticationInformation.returnUrl
is set to the URL to which the issuing bank redirects the
customer as discussed in Step 4: Step-Up Iframe.To request the Check Enrollment service, you must send either the encrypted payment data
or a token or some other equivalent of card data used by your integration. The request
fields can include any of these:
- paymentInformation.card.number
- paymentInformation.fluidData.value
- paymentInformation.fluidData.descriptor
- paymentInformation.customer.customerID
- tokenInformation.transientToken
These fields are required (merchant ID is in the header):
- consumerAuthenticationInformation.referenceId
- consumerAuthenticationInformation.returnUrl
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.totalAmount
- orderInformation.billTo.address1
- orderInformation.billTo.administrativeArea
- orderInformation.billTo.country
- orderInformation.billTo.email
- orderInformation.billTo.firstName
- orderInformation.billTo.lastName
- orderInformation.billTo.postalCode
- paymentInformation.card.expirationMonth
- paymentInformation.card.expirationYear
- paymentInformation.card.cardType
- paymentInformation.card.number
You can send additional request data to reduce your issuer step-up authentication rates.
Send all available fields. As a backup, if device data collection fails, include the 11
device information fields listed among the optional fields for the Check Enrollment
service in your request. If a failure does occur, adding these device information fields
ensures a transaction is not downgraded. If you do not have data for a field, do not
send dummy data.
The size of the step-up iframe discussed in Step 4: Step-Up Iframe can vary depending on the EMV 3-D Secure version of the transaction. You can request
the size of the challenge window in the
consumerAuthenticationInformation.acsWindowSize
request field. Requesting a specific window size does not guarantee this size. Parsing the PAReq as
described in Step 4: Step-Up Iframe determines the actual
size.
For further details on individual API fields, refer to the . The field values should
use the ISO 3166-2 format.