On This Page

{#jumplink-list}  
[Markdown](/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-processing-pa-process-intro/payments-processing-pa-amex-intro.md)  
Filter  
FILTER BY TAG

American Express SafeKey {#payments-processing-pa-amex-intro}
=============================================================

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.

consumerAuthenticationInformation.cavv
:
Required when payer authentication is successful.

processingInformation.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`).
    {#payments-processing-pa-amex-intro_ul_onm_fn1_jxb}

Processor-Specific Requirements {#payments-processing-pa-amex-intro_section_kl3_tbh_xwb}
----------------------------------------------------------------------------------------

**`Visa Platform Connect`**

processingInformation.authorizationOptions. transaction
:
Required only for merchants in Saudi Arabia.

Endpoint {#payments-processing-pa-amex-intro_d7e16}
---------------------------------------------------

**Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#payments-processing-pa-amex-intro_d7e25}  
**Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#payments-processing-pa-amex-intro_d7e35}

Related Information {#payments-processing-pa-amex-intro_section_c32_czz_wxb}
----------------------------------------------------------------------------

* [Payer Authentication Developer Guide \| REST API](https://developer.cybersource.com/docs/cybs/en-us/payer-authentication/developer/all/rest/payer-auth/pa2-intro-intro.md "")
  {#payments-processing-pa-amex-intro_ul_rdw_czz_wxb}

Required Fields for Processing an Authorization Using American Express SafeKey {#payments-processing-pa-amex-reqfields}
=======================================================================================================================

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.

> IMPORTANT  
> 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](/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-relax-reqs.md "").

clientReferenceInformation.code
:

consumerAuthenticationInformation.cavv
:

consumerAuthenticationInformation.eciRaw
:
Required when the payer authentication validation service returns a raw unmapped ECI value.

orderInformation.amountDetails.currency

orderInformation.amountDetails.totalAmount
:

orderInformation.billTo.address1
:

orderInformation.billTo.administrativeArea
:

orderInformation.billTo.country
:

orderInformation.billTo.email
:

orderInformation.billTo.firstName
:

orderInformation.billTo.lastName
:

orderInformation.billTo.locality
:

orderInformation.billTo.postalCode
:

paymentInformation.card.expirationMonth
:

paymentInformation.card.expirationYear
:

paymentInformation.card.number
:

paymentInformation.card.type
:

processingInformation.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`).
    {#payments-processing-pa-amex-reqfields_ul_onm_fn1_jxb}

Related Information
-------------------

* [API field reference guide for the REST API](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/rest-api-fields-intro.md "")

Optional Field for Processing an Authorization Using American Express SafeKey {#payments-processing-pa-amex-optfields}
======================================================================================================================

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.

consumerAuthenticationInformation.xid
:

Related Information
-------------------

* [API field reference guide for the REST API](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/rest-api-fields-intro.md "")

REST Example: Processing an Authorization Using American Express SafeKey {#payments-processing-pa-amex-ex-rest}
===============================================================================================================

Request

```
{
   "clientReferenceInformation": {
      "code": "TC50171_3"
   },
   "processingInformation": {
       "commerceIndicator": "aesk"
   },
   "paymentInformation": {
       "card": {
       "number": "3400000XXXXXXX8",
       "expirationMonth": "01",
       "expirationYear": "2025"
    }
  },
    "orderInformation": {
       "amountDetails": {
       "totalAmount": "100",
       "currency": "USD"
    },
    "billTo": {
       "firstName": "John",
       "lastName": "Smith",
       "address1": "201 S. Division St._1",
       "locality": "Foster City",
       "administrativeArea": "CA",
       "postalCode": "94404",
       "country": "US",
       "email": "accept@who.com",
       "phoneNumber": "6504327113"
     }
   },
       "consumerAuthenticationInformation": {
       "cavv": "1234567890987654321ABCDEFabcdefABCDEF123",
       "xid": "1234567890987654321ABCDEFabcdefABCDEF123"
       }
   }
```

Response to a Successful Request

```
{
  "_links": {
    "authReversal": {
      "method": "POST",
      "href": "/pts/v2/payments/6783071542936193303955/reversals"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/6783071542936193303955"
    },
    "capture": {
      "method": "POST",
      "href": "/pts/v2/payments/6783071542936193303955/captures"
    }
  },
  "clientReferenceInformation": {
    "code": "TC50171_3"
  },
  "id": "6783071542936193303955",
  "orderInformation": {
    "amountDetails": {
      "authorizedAmount": "100.00",
      "currency": "USD"
    }
  },
  "paymentAccountInformation": {
    "card": {
      "type": "003"
    }
  },
  "paymentInformation": {
    "accountFeatures": {
      "currency": "usd",
      "balanceAmount": "70.00"
    },
    "tokenizedCard": {
      "type": "003"
    },
    "card": {
      "type": "003"
    }
  },
  "pointOfSaleInformation": {
    "terminalId": "111111"
  },
  "processorInformation": {
    "approvalCode": "888888",
    "networkTransactionId": "123456789619999",
    "transactionId": "123456789619999",
    "responseCode": "100",
    "avs": {
      "code": "X",
      "codeRaw": "I1"
    }
  },
  "reconciliationId": "62427259FEYR18Q2",
  "status": "AUTHORIZED",
  "submitTimeUtc": "2023-03-08T20:25:54Z"
}
```

RELATED TO THIS PAGE