Setting Up Device Data Collection with a 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. In this scenario, a TMS token is used instead of the card.

Card-Specific Requirements

Some payment cards require specific information to be collected during a transaction.
card_cardType
This field is required when the card type is Cartes Bancaires, JCB, UnionPay International, or Meeza.

Country-Specific Requirements

These fields are required for transactions in specific countries.
billTo_state
This field is required for transactions in the US, Canada, and Mainland China.
billTo_postalCode
This field is required when the
billTo_country
field value is
US
or
CA
.
invoiceHeader_ merchantDescriptorCountry
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.
payerAuthEnrollService_ merchantCountrycode
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

Set the
payerAuthSetupService_run
field to
true
.
Send the request to:
Production:
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
Test:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Required Fields for Setting Up Data Collection When Using a 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.

Required Fields

billTo_postalCode
This field is required when the
billTo_country
field value is the US or CA.
billTo_state
This field is required for the US and Canada.
card_accountNumber
card_cardType
This field is required when the card type is Cartes Bancaires, JCB, UPI, or Meeza.
invoiceHeader_ merchantDescriptorCountry
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.
payerAuthEnrollService_ merchantCountrycode
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.
payerAuthSetupService_run
recurringSubscriptionInfo_subscriptionID
Setting Up Device Data Collection with a TMS Token