Simple Order 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 both services simultaneously, 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:
    payerAuthValidateReply_commerceIndicator
  • CAVV:
    payerAuthValidateReply_cavv
  • AAV:
    payerAuthValidateReply_ucafAuthenticationData
  • XID:
    payerAuthValidateReply_xid
If you request the services separately, you must manually pass the validation result values (Validation Check Response Fields) received in the response to 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 pass this information can invalidate your liability shift for that transaction. This transaction information includes 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
payerAuthValidateReply_ co mmerceIndicator
ccAuthService_commerceIn dicator
Collection indicator (Mastercard only)
payerAuthValidateReply_ucaf CollectionIndicator
ucaf_collectionIndicator
CAVV (Visa and American Express only)
payerAuthValidateReply_cavv
ccAuthService_cavv
AAV (Mastercard only. Known as UCAF)
payerAuthValidateReply_ucaf AuthenticationData
ucaf_authenticationData
XID
payerAuthValidateReply_xid
ccAuthService_xid
3-D Secure version
payerAuthValidateReply_spec ificationVersion
ccAuthService_paSpecifica tionVersion
Directory server transaction ID
(Not required for 3-D Secure 1.0.)
payerAuthValidateReply_dire ctoryServerTransactionID
ccAuthService_directorySer verTransactionID