On This Page
REST API
Requesting the Check Enrollment Service (SDK)
After the SDK completes the device collection from your mobile application and after the
customer clicks the ‘buy now’ button, you must make a back-end, server-to-server call to
request the Enrollment Check service.
The Check Enrollment service verifies that the card is enrolled in a card authentication
program. The merchant ID is included as part of the header but the following fields are
required in the request:
- clientReferenceInformation.code
- consumerAuthenticationInformation.referenceId
- 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.locality
- orderInformation.billTo.postalCode
- paymentInformation.card.expirationMonth
- paymentInformation.card.expirationYear
- paymentInformation.card.number
- paymentInformation.card.type
IMPORTANT
To reduce your issuer step-up authentication rates, you can send
additional request data in order. It is best to send all available fields.
You can use the enrollment check and card authorization services in the same request or
in separate requests:
- Same request:Cybersourceattempts to authorize the card if your customer is not enrolled in a payer authentication program. In this case, the field values that are required to prove that you attempted to check enrollment are passed automatically to the authorization service. If authentication is required, processing automatically stops.
- Separate requests: You must manually include the enrollment check result values (Enrollment Check response fields) in the authorization service request (Card Authorization request fields).
These fields are listed in the following table.
Identifier | Enrollment Check Response Field | Card Authorization Request Field |
|---|---|---|
consumerAuthenticationInformation.indicator | processingInformation.commerceIndicator | |
Collection indicator (Mastercard only) | consumerAuthenticationInformation.ucafCollectionIndicator | consumerAuthenticationInformation.ucafCollectionIndicator |
CAVV | consumerAuthenticationInformation.cavv | consumerAuthenticationInformation.cavv |
AAV | consumerAuthenticationInformation.ucafAuthenticationData | consumerAuthenticationInformation.ucafAuthenticationData |
XID | consumerAuthenticationInformation.xid
and | consumerAuthenticationInformation.xid |
Result of the enrollment check for Asia, Middle East, and
Africa Gateway | consumerAuthenticationInformation.veresEnrolled | consumerAuthenticationInformation.veresEnrolled |
3-D Secure version | consumerAuthenticationInformation.specificationVersion | consumerAuthenticationInformation.paSpecificationVersion |
Directory server transaction ID | consumerAuthenticationInformation.directoryServerTransactionId | consumerAuthenticationInformation.directoryServerTransactionId |