American Express SafeKey

American Express SafeKey is the authentication service in the American Express card network that uses the 3-D Secure protocol to validate customers at checkout. When you request an authorization using a supported card type and a supported processor, you can include payer authentication data in the request.
Before implementing payer authentication for American Express SafeKey, contact customer support to have your account configured for this feature.

Fields Specific to the American Express SafeKey Use Case

These API fields are required specifically for this use case.
ccAuthService_cavv
Required when payer authentication is successful.
ccAuthService_commerceIndicator
Set this field to one of these values:
  • aesk
    : Successful authentication (3-D Secure value of
    05
    ).
  • aesk_attempted
    : Authentication was attempted (3-D Secure value of
    06
    ).
  • internet
    : Authentication failed or was not attempted (3-D Secure value of
    07
    ).

Processor-Specific Requirements

Visa Platform Connect
transactionMode
Required only for merchants in Saudi Arabia.

Endpoint

Set the
ccAuthService_run
 field to
true
.
Send the request to
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
.

Required Fields for Processing an Authorization Using American Express SafeKey

These fields must be included in a request for an authorization with American SafeKey. The values for these fields are in the response from the payer authentication validate service. When you request the payer authentication validate and authorization services together, the data is automatically passed from one service to the other.
When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.
billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run
Set the value to
true
.
ccAuthService_cavv
ccAuthService_commerceIndicator
Set this field to one of these values:
  • aesk
    : Successful authentication (3-D Secure value of
    05
    ).
  • aesk_attempted
    : Authentication was attempted (3-D Secure value of
    06
    ).
  • internet
    : Authentication failed or was not attempted (3-D Secure value of
    07
    ).
ccAuthService_eciRaw
Required when the payer authentication validation service returns a raw ECI value.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
Either
purchaseTotals_grandTotalAmount
 or
item_#_unitPrice
 must be included in the request.
transactionMode
Required only for merchants in Saudi Arabia.
American Express SafeKey

Optional Field for Processing an Authorization Using American Express SafeKey

This field is optional in a request for an authorization with American Express SafeKey. The value for this field is in the response from the payer authentication validate service. When you request the payer authentication validate and authorization services together, the data is automatically passed from one service to the other.
ccAuthService_xid
American Express SafeKey

Simple Order Example: Processing an Authorization Using American Express SafeKey

Request
billTo_city=Sao Paulo
billTo_country=BR

billTo_email=null@cybersource.com

billTo_firstname=Julia
billTo_lastname=Fernandez
billTo_postalCode=01310-000
billTo_state=SP
billTo_street1=R. Augusta
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
ccAuthService_cavv=ABCDEFabcdefABCDEFabcdef0987654321234567
ccAuthService_commerceIndicator=aesk
merchant_id=MID23
merchant_referenceCode=Merchant_REF
purchaseTotals_currency=mxn
purchaseTotals_grandTotalAmount=100
Response to a Successful Request
merchantReferenceCode=Merchant_REF
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=mxn
ccAuthReply_cardCategory=F
ccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_reasonCode=100
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222
American Express SafeKey