On This Page

Checking Enrollment in Payer Authentication

The Check Enrollment service identifies the customer's bank and collects data about the device that the customer is using to place the order.

Card-Specific Requirements

Some payment cards require 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 (U.S.) when the product code is
AIR
for an airline purchase.
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 to
EG
when Egypt is not set as the country in the merchant configuration during merchant boarding.
invoiceHeader_ merchantDescriptorCountry: For Meeza transactions, this value must be set to
EG
when Egypt is not set as the country in the merchant configuration during merchant boarding.
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 the
billTo_country
field value is
US
or
CA
.

shipTo_county: This field is required when the
shipTo_country
field value is
CA
,
US
, or
China
.

shipTo_postalCode: This field is required when the
shipTo_country
field value is
US
or
CA
.

Processor-Specific Requirements

These fields are required by specific processors for transactions.

transactionMode: This field is required only for merchants in Saudi Arabia.

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

These fields are the minimum fields required for verifying that a customer is enrolled in a payer authentation program. 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_city
billTo_country: This field is required for transactions in the US and Canada.
billTo_email
billTo_firstName
billTo_httpBrowserColorDepth
billTo_httpBrowserJavaEnabled
billTo_httpBrowserJavaScriptEnabled
billTo_httpBrowserLanguage
billTo_httpBrowserScreenHeight
billTo_httpBrowserScreenWidth
billTo_httpBrowserTimeDifference
billTo_ipAddress
billTo_lastName
billTo_phoneNumber: This field is required if
payerAuthEnrollService_mobilePhone
or
billTo_workNumber
is not used.
billTo_postalCode: This field is required for transactions in the US and Canada.
billTo_state: This field is required for transactions in the US and Canada.
: billTo_street1
: card_accountNumber
card_cardType
card_expirationMonth: This field is required when
card_accountNumber
is included.
card_expirationYear: This field is required when
card_accountNumber
is included.
invoiceHeader_merchantDescriptorCountry: For Meeza transactions, this value must be set to
EG
when Egypt is not set as the country in the merchant configuration during merchant boarding.
merchantReferenceCode
payerAuthEnrollService_deviceChannel: This field is required for SDK integration. When you use the SDK integration, this field is dynamically set to
SDK
. When you use the JavaScript code, this field is dynamically set to
Browser
. For merchant-initiated or 3RI transactions, you must set the field to
3RI
. When you use this field in addition to JavaScript code, you must set the field to
Browser
.
payerAuthEnrollService_httpAccept: When the customer’s browser provides a value, include that value in your request.
payerAuthEnrollService_httpUserAccept
payerAuthEnrollService_httpUserAgent
payerAuthEnrollService_ merchantCountrycode: For Meeza transactions, this value must be set to
EG
when Egypt is not set as the country in the merchant configuration during merchant boarding.
payerAuthEnrollService_messageCategory
payerAuthEnrollService_mobilePhone: This field is required if
payerAuthEnrollService_workPhone
or
billTo_phoneNumber
is not used.
payerAuthEnrollService_referenceID
payerAuthEnrollService_returnURL
payerAuthEnrollService_run: This field is required (when available) unless market or regional mandate restricts sending this information.
payerAuthEnrollService_workPhone: This field is required if
payerAuthEnrollService_mobilePhone
or
billTo_phoneNumber
is not used.
purchaseTotals_currency
purchaseTotals_grandTotalAmount: This field is optional when you use the
item_#_unitPrice
field.

Optional Fields for Checking Enrollment in Payer Authentication

These fields are usually optional when you verify enrollment for a Payer Authentication transaction. In certain circumstances, the information provided by an optional field might be required before a transaction can proceed. Those optional fields that are sometimes required are also listed as required fields with the circumstance described.

airlineData_leg_#_carrierCode: This field is required for each leg.
airlineData_leg_#_departureDate: The numbered element name should contain 0 instead of #. Payer Authentication services only use the first leg of the trip.
airlineData_leg_#_destination: This field is required for each leg.
airlineData_leg_#_originatingAirportCode

airlineData_passenger_#_firstName
airlineData_passenger_#_lastName
billTo_customerAccountChangeDate
billTo_customerAccountCreateDate
billTo_customerAccountPasswordChange Date
billTo_passportCountry
billTo_passportNumber
acquirerInformation.bin
billTo_street2
billTo_street3
: card_accountNumber
card_cardType
card_cvNumber
ccAuthService_paChallengeCode
encryptedPayment_data
item_#_passengerFirstName
item_#_passengerLastName
item_#_productDescription
item_#_productName
item_#_productSKU
item_#_quantity
item_#_shippingAddress1
item_#_shippingAddress2
item_#_shippingCity
item_#_shippingCountryCode
item_#_shippingDestinationTypes
item_#_shippingFirstName
item_#_shippingLastName
item_#_shippingMiddleName
item_#_shippingPhone
item_#_shippingPostalCode
item_#_shippingState
item_#_totalAmount
item_#_unitPrice
merchantDefinedData_mddField_1 to merchantDefinedData_mddField_5: These fields override the old merchant-defined data fields. For example, when you use the obsolete field
merchantDefinedData_field5
and the new field
merchantDefinedData_mddField_5
in the same request, the new field value overwrites the value specified in the obsolete field.

Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, Social Security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). When a merchant is discovered capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether intentionally or accidentally, the merchant's account is immediately suspended, resulting in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.
merchantReferenceCode
pa_otpToken
payerAuthEnrollReply_authenticationBrand: This field is only used with mada cards.
payerAuthEnrollReply_authorizationPayload
payerAuthEnrollService_accountPurchases: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_acquirerCountry
payerAuthEnrollService_acsWindowSize
payerAuthEnrollService_addCardAttempts: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_alternateAuthent icationData
payerAuthEnrollService_alternateAuthenticationDate

payerAuthEnrollService_alternateAuthenticationMethod
payerAuthEnrollService_authenticationIndicator
payerAuthEnrollService_authenticationTransactionID: This field is required for Standard integration.
payerAuthEnrollService_challengeCode: This field defaults to
01
on your account but is overridden by the merchant when you include this field. EMV 3-D Secure version 2.1.0 supports values
01
-
04
. Version 2.2.0 supports values
01
-
09
.; Modifying this field could affect your liability shifts. Unless you are very familiar with the various types of authentication, do not change the default settings before consulting with customer support.
payerAuthEnrollService_customerCCAlias: This field is required when tokenization is enabled in the merchant profile settings.
payerAuthEnrollService_decoupled_AuthenticationMaxTime
payerAuthEnrollService_decoupledAuthenticationIndicator
payerAuthEnrollService_defaultCard: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_fraudActivity: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_giftCardAmount
payerAuthEnrollService_giftCardCount
payerAuthEnrollService_giftCardCurrency
payerAuthEnrollService_installmentTotalCount: This field is required when the merchant and cardholder have agreed to installment payments.
payerAuthEnrollService_marketingOptIn: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_marketingSource: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_MCC: This field is required when the card type is Cartes Bancaires.
payerAuthEnrollService_merchantFraudRate
payerAuthEnrollService_merchantID: This field is the merchant bank identifier, such as Paymentech’s division, FDC’s Terminal ID, or Vital V number. Use this field for evaluation, testing, and production. This number is not your merchant ID.
payerAuthEnrollService_merchantName: This field is required for Visa Secure travel.
payerAuthEnrollService_merchantNewCustomer
payerAuthEnrollService_merchantScore: This field is required for transactions processed in France.
payerAuthEnrollService_merchantURL
payerAuthEnrollService_messageCategory
payerAuthEnrollService_overridePay mentMethod
payerAuthEnrollService_paymentAccountDate payerAuthEnrollService_paymentAccountDate: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_preorder
payerAuthEnrollService_preorderDate
payerAuthEnrollService_priorAuthenticationData
payerAuthEnrollService_priorAuthenticationMethod
payerAuthEnrollService_priorAuthenticationReferenceID
payerAuthEnrollService_priorAuthenticationTime
payerAuthEnrollService_productCode: This field is required for American Express SafeKey (U.S.) when the product code is AIR (Airline purchase).
payerAuthEnrollService_recurringEndDate: This field is required for recurring transactions.
payerAuthEnrollService_recurringFrequency: This field is required for recurring transactions.
payerAuthEnrollService_recurringOriginal PurchaseDate: This field is required for recurring transactions.
payerAuthEnrollService_referenceID: This field is required for Hybrid or Cardinal Cruise Direct Connection API integration.
payerAuthEnrollService_reorder
payerAuthEnrollService_requestorInitiatedAuthenticationIndicator: EMV 3-D Secure version 2.1.0 supports values
01
-
05
. Version 2.2.0 supports values
01
-
11
.
: payerAuthEnrollService_requestorName
payerAuthEnrollService_returnURL
payerAuthEnrollService_scoreRequest
payerAuthEnrollService_sdkMaxTimeout: This field is required for 3-D Secure 2.x.
payerAuthEnrollService_secureCorporatePaymentIndicator
payerAuthEnrollService_shipAddressUsageDate: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_totalOffersCount
payerAuthEnrollService_transactionCountDay payerAuthEnrollService_transactionCountDay: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionCountYear payerAuthEnrollService_transactionCountYear: This field is recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionMode
payerAuthEnrollService_whiteListStatus payerAuthEnrollService_whiteListStatus
paymentNetworkToken_transactionType
requestID
shipTo_city: This field is required when any shipping address information is included. Required for American Express SafeKey (US).
shipTo_country: This field is required only for American Express SafeKey (US).
shipTo_destinationCode
shipTo_destinationTypes: This field is required when the
bill_country
field value is
US
or
CA
.
shipTo_firstName
shipTo_lastName
shipTo_middleName
shipTo_phoneNumber
shipTo_postalCode: This field is required when the
shipTo_country
field value is
US
or
CA
. Required for American Express SafeKey (U.S.).
shipTo_shippingMethod: This field is required only for American Express SafeKey (US).
shipTo_state: This field is required when the
shipTo_country
field value is
CA
,
US
, or
Mainland China
. Required for American Express SafeKey (U.S.).
shipTo_street1: This field is required when any shipping address information is included. Required for American Express SafeKey (US).
shipTo_street2: This field is required only for American Express SafeKey (US).
> shipTo_street3: This field is required for American Express SafeKey (US).

Simple Order Example: Checking Enrollment

Request

billTo_city=Mountain View
billTo_country=US
billTo_email=test@email.com
billTo_firstName=Tanya
billTo_lastName=Lee
billTo_postalCode=94043
billTo_state=CA
billTo_street1=1234 Gold Ave
card_accountNumber=XXXXXXXXXXXXXXXX
card_cardType=001
card_cvNumber=111
card_expirationMonth=12
card_expirationYear=2030
ccAuthService_run=true
merchantID=patest
merchantReferenceCode=0001
payerAuthEnrollService_referenceID=f13fe5e0-9b47-4ea1-a03a-ec360f4d0f9f
payerAuthEnrollService_returnURL=https://example.com/step-up-return-url.jsp
payerAuthEnrollService_run=true
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=30.00

Response


decision=REJECT
merchantReferenceCode=0001
payerAuthEnrollReply_accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1MDc4OTI0Mi0z YmEzLTRhZTItYWQwOS1kZjZkODk2NWQ5MjciLCJpYXQiOjE1OTgyOTk1MjQsImlzcyI6IjVkZDgzYmYwMGU0MjNk MTQ5OGRjYmFjYSIsImV4cCI6MTU5ODMwMzEyNCwiT3JnVW5pdElkIjoiNTVlZjNmMTBmNzIzYWE0MzFjOTliNWViIi wiUGF5bG9hZCI6eyJBQ1NVcmwiOiJodHRwczovLzBtZXJjaGFudGFjc3N0YWcuY2FyZGluYWxjb21tZXJjZS5jb20 vTWVyY2hhbnRBQ1NXZWIvY3JlcS5qc3AiLCJQYXlsb2FkIjoiZXlKdFpYTnpZV2RsVkhsd1pTSTZJa05TWlhFaUxDS nRaWE56WVdkbFZtVnljMmx2YmlJNklqSXVNaTR3SWl3aWRHaHlaV1ZFVTFObGNuWmxjbFJ5WVc1elNVUWlPaUkzT kRNeVlUWXdNQzA0TXpNMkxUUm1PRGN0WVdKbE9TMDJObVkzTkRFM01EaGhNV1FpTENKaFkzTlVjbUZ1YzBsRUlqb 2lPR0U1TkRkaU9ETXRNRFJpTkMwMFltVmlMV0V5WWpNdFpHTmpNV0UxWmprMFlURXlJaXdpWTJoaGJHeGxibWRsVj JsdVpHOTNVMmw2WlNJNklqQXlJbjAiLCJUcmFuc2FjdGlvbklkIjoiVEQ1b1MwbzFGQzY1cWF2MHhzeDAifS wiT2JqZWN0aWZ5UGF5bG9hZCI6dHJ1ZSwiUmV0dXJuVXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9zdGVwLXV wLXJldHVybi11cmwuanNwIn0.8wZ8XhLgOIIRvgEUugvYrRAi-efavZTNM0tWInYLTfE
payerAuthEnrollReply_acsTransactionID=8a947b83-04b4-4beb-a2b3-dcc1a5f94a12
payerAuthEnrollReply_acsURL=https://0merchantacsstag.cardinalcommerce.com/MerchantACSWeb/creq.jsp
payerAuthEnrollReply_authenticationTransactionID=TD5oS0o1FC65qav0xsx0
payerAuthEnrollReply_cardBin=40000000
payerAuthEnrollReply_cardTypeName=VISA
payerAuthEnrollReply_challengeRequired=false
payerAuthEnrollReply_directoryServerTransactionID=395fb036-cfc6-462b-b28d-d6ed7c970cdd
payerAuthEnrollReply_paReq=eyJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMi4wIiwidGhy ZWVEU1NlcnZlclRyYW5zSUQiOiI3NDMyYTYwMC04MzM2LTRmODctYWJlOS02NmY3NDE3MDhhMWQiLCJhY3NU cmFuc0lEIjoiOGE5NDdiODMtMDRiNC00YmViLWEyYjMtZGNjMWE1Zjk0YTEyIiwiY2hhbGxlbmdlV2luZG93U2l 6ZSI6IjAyIn0
payerAuthEnrollReply_reasonCode=475
payerAuthEnrollReply_specificationVersion=2.2.0
payerAuthEnrollReply_stepUpUrl=https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp
payerAuthEnrollReply_threeDSServerTransactionID=7432a600-8336-4f87-abe9-66f741708a1d
payerAuthEnrollReply_veresEnrolled=Y
reasonCode=475
requestID=5982995245816268803007
requestToken=AxjzbwSTRFa9DM1xnUu/ABEBURwlqsQ5pAy7gDtXb0kyro9JLIYA8AAA2wK2