On This Page
REST API

Requesting the Check Enrollment Service

Request the Check Enrollment service to verify that the card is enrolled in a card authentication program. The following fields are required:
  • orderInformation.amountDetails.totalAmount
  • orderInformation.billTo.address1
  • orderInformation.billTo.locality
  • orderInformation.billTo.country
  • orderInformation.billTo.administrativeArea
  • orderInformation.billTo.postalCode
  • paymentInformation.card.type
  • orderInformation.amountDetails.currency
  • paymentInformation.card.expirationMonth
  • paymentInformation.card.expirationYear
  • orderInformation.billTo.email
  • orderInformation.billTo.firstName
  • orderInformation.billTo.lastName
  • consumerAuthenticationInformation.referenceId
  • clientReferenceInformation.code
To reduce your issuer step-up authentication rates, you can send additional request data in order. It is recommended 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:
    Cybersource
     attempts to authorize the card when 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).
The following table lists these fields.
Enrollment Check and Response Fields
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
(Not required for 3-D Secure 1.0.)
consumerAuthenticationInformation.directoryServerTransactionId
consumerAuthenticationInformation.directoryServerTransactionId