Use Case: Collecting Device Data Using a Stored Payment Credential (TMS Token)

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. This use case includes using a token during the process.

Card-Specific Requirements

Some payment cards require specific information to be collected during a transaction.
This field is 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
EG
 if Egypt was not set as the country in merchant configuration during merchant onboarding.
This field is required for transactions in the US, Canada, and Mainland China.
This field is required when the
orderInformation.billTo.country
 field value is
US
 or
CA
.
For Meeza transactions, this value must be set to
EG
 if Egypt was not set as the country in the 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 Collecting Device Data Using a Stored Payment Credential (TMS Token)

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
EG
if Egypt was not set as the country in the merchant configuration during the merchant onboarding.
For Meeza transactions, this value must be set to
EG
if Egypt was not set as the country in the merchant configuration during the merchant onboarding.
This field is required for the US, Canada, and Mainland China.
This field is required when the
orderInformation.billTo.country field
field value is
US
or
CA
.
This field is required when the card type is Cartes Bancaires, JCB, UPI, or Meeza.

Optional Fields for Setting Up Payer Authentication

REST Example: Collecting Device Data Using a Stored Payment Credential (TMS Token)

Endpoint

Production:
POST
https://api.cybersource.com
/risk/v1/authentication-setups
Test:
POST
https://apitest.cybersource.com
/risk/v1/authentication-setups
Request 
    
{
  "paymentInformation": {
    "card": {
      "expirationMonth": "05",
      "expirationYear": "2029",
    },
    "customer": {
      "customerId": "1108590036500854"
    }
  }
}
Response to a Successful Request 
    
 {
  "clientReferenceInformation": {
    "code": "1675295420285",
  },
  "consumerAuthenticationInformation": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhNmVlN2NlNi1mMjQ5LTRjOTktYj
    Q1NC0yYTA2ZmFmMWUzM2EiLCJpYXQiOjE3MTU5NDMwNTEsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIs
    ImV4cCI6MTcxNTk0NjY1MSwiT3JnVW5pdElkIjoiNjY0MWRiMGZmOTRmNzI3ZjU0Y2RlOTQ2IiwiUmVmZXJlbmNlSW
    QiOiJiODk4OTE2NS00NjNmLTRjNzQtYmYxNy05NjM1YjQzYmNlZjAifQ.mbDLnid0_pLuami7wEo3gB-uZTWRByQ5L
    -cj6-AlQ9k",
    "deviceDataCollectionUrl": "https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect",
    "referenceId": "b8989165-463f-4c74-bf17-9635b43bcef0",
    "token": "AxizbwSThB0OsMK2B/CiAG8BT34OSB84AgVQyaSZejF9z2oA8AAA2gbZ"
  },
  "id": "7159430505826404004002",
  "status": "COMPLETED",
  "submitTimeUtc": "2024-05-17T10:50:51Z"
}