Simple Order 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 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 these fields are required in the request:
  • billTo_city
  • billTo_country
  • billTo_email
  • billTo_firstName
  • billTo_lastName
  • billTo_postalCode
  • billTo_state
  • billTo_street1
  • card_accountNumber
  • card_cardType
  • card_expirationMonth
  • card_expirationYear
  • merchantID
  • merchantReference Code
  • payerAuthEnrollService_referenceID
  • payerAuthEnrollService_run
  • purchaseTotals_currency
  • purchaseTotals_grandTotalAmount
To reduce your issuer step-up authentication rates, you can send additional request data in order. It is best to send all available fields.
Use the enrollment check and card authorization services in the same request or in separate requests:
  • Same request:
    Barclays
    attempts 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: Manually include the enrollment check result values (Enrollment Check response fields) in the authorization service request (Card Authorization request fields).
Be sure to include the following card-specific information in your authorization request:
  • For Visa, American Express, JCB, Diners Club, Discover, China UnionPay, and Elo, include the CAVV.
  • For Mastercard only, include the collection indicator and the AAV (also known as UCAF).
These fields are listed in this table.
Enrollment Check and Response Fields
Identifier
Enrollment Check Response Field
Card Authorization Request Field
E-commerce indicator
payerAuthEnrollReply_ commerceIndicator
ccAuthService_commerceIn dicator
Collection indicator
payerAuthEnrollReply_ucaf CollectionIndicator
ucaf_collectionIndicator
CAVV
payerAuthValidateReply_cavv
ccAuthService_cavv
AAV
payerAuthValidateReply_ucafAuthenticationData
ucaf_authenticationData
XID
payerAuthEnrollReply_xid
and
payerAuthValidateReply_xid
ccAuthService_xid
Result of the enrollment check for Asia, Middle East, and Africa Gateway
payerAuthEnrollReply_veresEnrolled
3-D Secure version
payerAuthEnrollReply_specificationVersion
ccAuthService_paSpecificationVersion
Directory server transaction ID
(Not required for 3-D Secure 1.0.)
payerAuthEnrollReply_direc toryServerTransactionID
ccAuthService_directorySer verTransactionID