On This Page
Checking Enrollment in Payer Authentication
The Check Enrollment service tries to authenticate the cardholder. If the cardholder can
be authenticated without additional information, the transaction can be authorized. If
more information is required, the cardholder will be challenged to provide additional
authentication.
Card-Specific Requirements
Some payment cards require information to be collected during a transaction.
- This field is required when the card type isJCB,Cartes Bancaires, China UnionPay, or Meeza.
- This field is recommended for Discover ProtectBuy.
- This field is required when the card type is Cartes Bancaires.
- This field is required for Visa Secure travel.
- This field is required for American Express SafeKey (U.S.) when the product code isAIRfor an airline purchase.
- This field is required only for American Express SafeKey (US).
- This field is required only for American Express SafeKey (US).
- This field is required for American Express SafeKey (US).
- This field is required only for American Express SafeKey (US).
- This field is required only for American Express SafeKey (US.)
Country-Specific Requirements
These fields are required for transactions in specific countries.
- This field is required for transactions processed in France.
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant boarding.
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant boarding.
- This field is required for transactions in the US and Canada.
- This field is required for transactions in the US and Canada.
- This field is required when thebillTo_countryfield value isUSorCA.
- This field is required when theshipTo_countryfield value isCA,US, orChina.
- This field is required when theshipTo_countryfield value isUSorCA.
Processor-Specific Requirements
These fields are required by specific processors for transactions.
- 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
- This field is required for transactions in the US and Canada.
- This field is required ifpayerAuthEnrollService_mobilePhoneorbillTo_workNumberis not used.
- This field is required for transactions in the US and Canada.
- This field is required for transactions in the US and Canada.
- This field is required whencard_accountNumberis included.
- This field is required whencard_accountNumberis included.
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant boarding.
- This field is required for SDK integration. When you use the SDK integration, this field is dynamically set toSDK. When you use the JavaScript code, this field is dynamically set toBrowser. For merchant-initiated or 3RI transactions, you must set the field to3RI. When you use this field in addition to JavaScript code, you must set the field toBrowser.
- When the customer’s browser provides a value, include that value in your request.
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant boarding.
- This field is required ifpayerAuthEnrollService_workPhoneorbillTo_phoneNumberis not used.
- payerAuthEnrollService_run
- This field is required (when available) unless market or regional mandate restricts sending this information.
- This field is required ifpayerAuthEnrollService_mobilePhoneorbillTo_phoneNumberis not used.
- This field is optional when you use theitem_#_unitPricefield.
Related Information
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.
- This field is required for each leg.
- The numbered element name should contain 0 instead of #. Payer Authentication services only use the first leg of the trip.
- This field is required for each leg.
- airlineData_numberOfPassengers
- billTo_customerAccountChangeDate
- billTo_customerAccountCreateDate
- billTo_customerAccountPasswordChange Date
- merchantDefinedData_mddField_1tomerchantDefinedData_mddField_5
- These fields override the old merchant-defined data fields. For example, when you use the obsolete fieldmerchantDefinedData_field5and the new fieldmerchantDefinedData_mddField_5in 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.
- pa_otpToken
- This field is only used with mada cards.
- This field is recommended for Discover ProtectBuy.
- payerAuthEnrollService_addCardAttempts
- This field is recommended for Discover ProtectBuy.
- This field is required for Standard integration.
- This field defaults to01on your account but is overridden by the merchant when you include this field. EMV 3-D Secure version 2.1.0 supports values01-04. Version 2.2.0 supports values01-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.
- This field is required when tokenization is enabled in the merchant profile settings.
- This field is recommended for Discover ProtectBuy.
- This field is recommended for Discover ProtectBuy.
- This field is required when the merchant and cardholder have agreed to installment payments.
- This field is recommended for Discover ProtectBuy.
- This field is recommended for Discover ProtectBuy.
- This field is required when the card type is Cartes Bancaires.
- 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.
- This field is required for Visa Secure travel.
- This field is required for transactions processed in France.
- payerAuthEnrollService_ paymentAccountDate
- This field is recommended for Discover ProtectBuy.
- This field is required for American Express SafeKey (U.S.) when the product code is AIR (Airline purchase).
- This field is required for recurring transactions.
- This field is required for recurring transactions.
- This field is required for recurring transactions.
- This field is required for Hybrid or Cardinal Cruise Direct Connection API integration.
- EMV 3-D Secure version 2.1.0 supports values01-05. Version 2.2.0 supports values01-11.
- This field is required for 3-D Secure 2.x.
- This field is recommended for Discover ProtectBuy.
- payerAuthEnrollService_transactionCount Day
- This field is recommended for Discover ProtectBuy.
- payerAuthEnrollService_transactionCount Year
- This field is recommended for Discover ProtectBuy.
- payerAuthEnrollService_whiteListStatus
- This field is required when any shipping address information is included. Required for American Express SafeKey (US).
- This field is required only for American Express SafeKey (US).
- This field is required when thebill_countryfield value isUSorCA.
- This field is required when theshipTo_countryfield value isUSorCA. Required for American Express SafeKey (U.S.).
- This field is required only for American Express SafeKey (US).
- This field is required when theshipTo_countryfield value isCA,US, orMainland China. Required for American Express SafeKey (U.S.).
- This field is required when any shipping address information is included. Required for American Express SafeKey (US).
- This field is required only for American Express SafeKey (US).
- 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