Checking Enrollment When Using a TMS Token
Running the Check Enrollment service identifies the customer's bank and collects data
about the device that the customer is using to place the order. This use case
demostrates this process while using a TMS token.
Card-Specific Requirements
Some payment cards require additional information to be collected during a
transaction.
- card_cardType
- This field is required when the card type is Cartes Bancaires, JCB, UPI, or Meeza.
- payerAuthEnrollService_defaultCard
- This field is recommended for Discover ProtectBuy.
- payerAuthEnrollService_MCC
- This field is required when the card type is Cartes Bancaires.
- payerAuthEnrollService_merchantName
- This field is required for Visa Secure travel.
- payerAuthEnrollService_productCode
- This field is required for American Express SafeKey (US) when the product code isAirlinepurchase(AIR).
- shipTo_city
- This field is required only for American Express SafeKey (US).
- shipTo_country
- This field is required only for American Express SafeKey (US).
- shipTo_postalCode
- This field is required for American Express SafeKey (US).
- shipTo_street1
- This field is required only for American Express SafeKey (US).
- shipTo_street2
- This field is required only for American Express SafeKey (US.)
Country-Specific Requirements
These fields are required for transactions in specific countries.
- payerAuthEnrollService_merchantScore
- This field is required for transactions processed in France.
- payerAuthEnrollService_ merchantCountrycode
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant onboarding.
- invoiceHeader_merchantDescriptorCountry
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant onboarding.
- billTo_state
- This field is required for transactions in the US and Canada.
- billTo_city
- This field is required for transactions in the US and Canada.
- billTo_postalCode
- This field is required when thebillTo_countryfield value isUSorCA.
- shipTo_county
- This field is required when theshipTo_countryfield value isCAorUS.
- shipTo_postalCode
- This field is required when theshipTo_countryfield value isUSorCA.
Endpoint
Set the
ccAuthService_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 Checking Enrollment in Payer
Authentication While Using a TMS Token
These fields are the minimum fields required for verifying that a customer is
enrolled in a payer authentication program. It doesn't matter if the enrollment
check is frictionless or results in a challenge, the same fields are required in the
request. The fields in the response will differ.
Required Fields
- billTo_city
- billTo_country
- This field is required for the US and Canada.
- billTo_email
- billTo_firstName
- billTo_httpBrowserScreenHeight
- billTo_httpBrowserScreenWidth
- billTo_ipAddress
- billTo_lastName
- billTo_postalCode
- This field is required for the US and Canada.
- billTo_state
- This field is required for the US and Canada.
- billTo_street1
- card_cardType
- card_expirationMonth
- This field is required whencard_accountNumberis included.
- card_expirationYear
- This field is required whencard_accountNumberis included.
- invoiceHeader_merchantDescriptorCountry
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant onboarding.
- merchantReferenceCode
- payerAuthEnrollService_ merchantCountrycode
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant onboarding.
- payerAuthEnrollService_referenceID
- payerAuthEnrollService_returnURL
- payerAuthEnrollService_run
- This field is required (when available) unless market or regional mandate restricts sending this information.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- This field is optional when you use theitem_#_unitPricefield.