On This Page
Simple Order API

Optional Fields for Checking Enrollment in Payer Authentication

These fields are usually optional when verifying 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.
The fields that are marked with a single asterisk (*) in front are browser-related fields. The information collected by these browser-related fields, while not required, is highly recommended for all EMV 3-D Secure transactions.
The fields that are marked with a double asterisk (**) at the end will be required as part of the EMV 3-D Secure 2.x minimum data requirements for Visa Secure. These conditionally optional fields will be removed from the optional fields list and moved to the required list on August 12, 2024.
Required for each leg.
The numbered element name should contain 0 instead of #. Payer Authentication services only use the first leg of the trip.
Required for each leg.
airlineData_numberOfPassengers
Required when the
billTo_country
 field is
US
 or
CA
.
billTo_customerAccountChangeDate
billTo_customerAccountCreateDate
billTo_customerAccountPasswordChange Date
Required if
payerAuthEnrollService_mobilePhone
 or
billTo_workNumber
 is not used.
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.
pa_otpToken
Recommended for Discover ProtectBuy.
payerAuthEnrollService_addCardAttempts
Recommended for Discover ProtectBuy.
Required for Standard integration.
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 liability shifts down the payment chain. Unless you are very familiar with the various types of authentication, do not change the default settings before consulting with customer support.
Required when tokenization is enabled in the merchant profile settings.
Recommended for Discover ProtectBuy.
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
.
Recommended for Discover ProtectBuy.
When the customer’s browser provides a value, include that value in your request.
Required when the merchant and cardholder have agreed to installment payments.
Recommended for Discover ProtectBuy.
Recommended for Discover ProtectBuy.
Required when the card type is Cartes Bancaires.
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.
Required for Visa Secure travel.
Required for transactions processed in France.
Required if
payerAuthEnrollService_workPhone
 or
billTo_phoneNumber
 is not used.
payerAuthEnrollService_paymentAccount Date
Recommended for Discover ProtectBuy.
Required for American Express SafeKey (U.S.) when the product code is AIR (Airline purchase).
Required for recurring transactions.
Required for recurring transactions.
Required for recurring transactions.
Required for Hybrid or Cardinal Cruise Direct Connection API integration.
EMV 3-D Secure version 2.1.0 supports values
01
-
05
. Version 2.2.0 supports values
01
-
11
.
Required for 3-D Secure 2.x.
Recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionCount Day
Recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionCount Year
Recommended for Discover ProtectBuy.
payerAuthEnrollService_whiteListStatus
Required if
payerAuthEnrollService_mobilePhone
 or
billTo_phoneNumber
 is not used.
Required when any shipping address information is included. Required for American Express SafeKey (US).
Required only for American Express SafeKey (US).
Required when the
bill_country
 field value is
US
 or
CA
.
Required when the
shipTo_country
 field value is
US
 or
CA
. Required for American Express SafeKey (U.S.).
Required only for American Express SafeKey (US).
Required when the
shipTo_country
 field value is
CA
,
US
, or
Mainland China
. Required for American Express SafeKey (U.S.).
Required when any shipping address information is included. Required for American Express SafeKey (US).
Required only for American Express SafeKey (US).
Required for American Express SafeKey (US).