Use Case: Setting Up Payer Authentication

Running the Setup service identifies the customer's bank and prepares for collecting data about the device that the customer is using to place the order.

Card-Specific Requirements

Some payment cards require specific information to be collected during a transaction.
Required when the card type is Cartes Bancaires, JCB, UPI, or Meeza.

Country-Specific Requirements

These fields are required for transactions in specific countries.
For Meeza transactions, this value must be set to Egypt if Egypt was not set as the country in merchant configuration during merchant onboarding.
Required for transactions in the US, Canada, and Mainland China.
Required when the
orderInformation.billTo.country
 field value is
US
 or
CA
.
For Meeza transactions, this value must be set to Egypt if Egypt was not set as the country in merchant configuration during merchant onboarding.

Endpoint

Production:
POST
https://api.cybersource.com
/risk/v1/authentication-setups
Test:
POST
https://apitest.cybersource.com
/risk/v1/authentication-setups

Required Fields for Setting Up Payer Authentication

These fields are the minimum fields required when you request the Payer Authentication Setup service. Other fields that can be used to collect additional information during a transaction are listed in the optional fields section. Under certain circumstances, a field that normally is optional might be required. The circumstance that makes an optional field required is noted.
For Meeza transactions, this value must be set to Egypt if Egypt was not set as the country in merchant configuration during merchant onboarding.
For Meeza transactions, this value must be set to Egypt if Egypt was not set as the country in merchant configuration during merchant onboarding.
Required for the US, Canada, and Mainland China.
Required when the
orderInformation.billTo.country field
field value is
US
or
CA
.
Required when the card type is Cartes Bancaires, JCB, UPI, Meeza.

Optional Fields for Setting Up Payer Authentication

REST Example: Setting Up Payer Authentication

Request 
        
{
  "paymentInformation": {
    "card": {
      "type": "001",
      "expirationMonth": "12",
      "expirationYear": "2025",
      "number": "400000000000XXXX"
    }
  }
}
Response to Successful Request 
        
 {
  "clientReferenceInformation": {
    "code": "1675295420285",
  },
  "consumerAuthenticationInformation": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwYTFmZjNmYS02YTdiLTQ0NjYtYTgzOC04NTNjOTk2ZTMw
                                   MDYiLCJpYXQiOjE2NzUyOTU0MjAsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTY3NTI
                                   5OTAyMCwiT3JnVW5pdElkIjoiNWI5YzRiYjNmZjYyNmIxMzQ0ODEwYTAxIiwiUmVmZXJlbmNlSWQiOiIzOTE2M
                                   GMyZC1jMWU0LTQ0NjUtYWNlMy1lYjMyZDVhMWQ1NTkifQ.dl3w8s_ZpjA7kWmikyyYHO1Ak4TnzUHv8BuPra
                                   tQukc",
    "deviceDataCollectionUrl": "https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect",
    "referenceId": "39160c2d-c1e4-4465-ace3-eb32d5a1d559",
    "token": "AxizbwSTbhQQxCrDMCazABEBT9u+U5WYAXsQyaSZejFczCmAMAAAwAnp"
  },
  "id": "6752954202146024203955",
  "status": "COMPLETED",
  "submitTimeUtc": "2023-02-01T23:50:20Z"
}