REST API

Combining Services or Mapping Authorization Fields

It is recommended that you request both payer authentication and card authorization services at the same time. When you do so, the correct information is automatically sent to your payment processor with the values of these fields being converted to the proper format required by your payment processor:
  • E-commerce indicator:
    consumerAuthenticationInformation.ecommerceIndicator
  • CAVV:
    consumerAuthenticationInformation.cavv
  • AAV:
    consumerAuthenticationInformation.ucafAuthenticationData
  • XID:
    consumerAuthenticationInformation.xid
If you request the services separately, you must manually include the validation result values (Validation Check Response Fields) in the authorization service request (Card Authorization Request Fields). To receive liability shift protection, you must ensure that you pass all pertinent data for the card type and processor in your request. Failure to do so can invalidate your liability shift for that transaction. Include the electronic commerce indicator (ECI), the transaction ID (XID), the 3-D Secure version, the directory server transaction ID, and the following card-specific information in your authorization request:
  • For Visa, American Express, JCB, Diners Club, Discover, China UnionPay, and Elo include the CAVV (cardholder authentication verification value).
  • For Mastercard, include the UCAF (universal cardholder authentication field) and the collection indicator.
Depending on your card type and whether it is a 3-D Secure 1.0 or 2.x transaction, you might not receive the XID. If you receive this field back, it is required for authorization.
The following table lists these fields.
Identifier
Validation Check Response Field
Card Authorization Request Field
E-commerce indicator
consumerAuthenticationInformation.ecommerceIndicator
processingInformation.eCommerceIndicator
Collection indicator (Mastercard only)
consumerAuthenticationInformation.ucafCollectionIndicator
consumerAuthenticationInformation.ucafCollectionIndicator
CAVV (Visa and American Express only)
consumerAuthenticationInformation.cavv
consumerAuthenticationInformation.cavv
AAV (Mastercard only. Known as UCAF)
consumerAuthenticationInformation.ucafAuthenticationData
consumerAuthenticationInformation.ucafAuthenticationData
XID
consumerAuthenticationInformation.xid
consumerAuthenticationInformation.xid
3-D Secure version
consumerAuthenticationInformation.specificationVersion
consumerAuthenticationInformation.specificationVersion
Directory server transaction ID
(Not required for 3-D Secure 1.0.)
consumerAuthenticationInformation.directoryServerTransactionId
consumerAuthenticationInformation.directoryServerTransactionId