Optional Fields for Enrolling in Payer Authentication

While these fields are optional when checking if the card holder is enrolled in a Payer Authentication program, in certain circumstances, additional information on the card holder may be required before the transaction can proceed. The circumstance when an optional field is required is noted.

The fields that are marked with an asterisk are browser-related fields. The information collected by these browser-related fields are useful during 3-D Secure transactions.

airlineData_leg_#_carrierCode: 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: Required for each leg.
airlineData_leg_#_originatingAirportCode
airlineData_numberOfPassengers
airlineData_passenger_#_firstName
airlineData_passenger_#_lastName
billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode: Required when the
billTo_country
field is
US
or
CA
.
billTo_customerAccountChangeDate
billTo_customerAccountCreateDate
billTo_customerAccountPasswordChange Date
*billTo_httpBrowserColorDepth
*billTo_httpBrowserJavaEnabled
*billTo_httpBrowserJavaScriptEnabled
*billTo_httpBrowserLanguage
*billTo_httpBrowserScreenHeight
*billTo_httpBrowserScreenWidth
*billTo_httpBrowserTimeDifference
*billTo_ipAddress
billTo_passportCountry
billTo_passportNumber
billTo_street1
billTo_street2
billTo_street3
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
payerAuthEnrollService_accountPur chases: Recommended for Discover ProtectBuy.
payerAuthEnrollService_acquirerCoun try
payerAuthEnrollService_acsWindowSize
payerAuthEnrollService_addCardAttempts: Recommended for Discover ProtectBuy.
payerAuthEnrollService_alternateAuthent icationData
payerAuthEnrollService_alternateAuthent icationDate
payerAuthEnrollService_alternateAuthent icationMethod
payerAuthEnrollService_authenticationIn dicator
payerAuthEnrollService_authenticationTr ansactionID: 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 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.
payerAuthEnrollService_customerCCAlias: Required when tokenization is enabled in the merchant profile settings
.
payerAuthEnrollService_decoupled_Authen ticationMaxTime
payerAuthEnrollService_decoupledAuthen ticationIndicator
payerAuthEnrollService_defaultCard: Recommended for Discover ProtectBuy.
*payerAuthEnrollService_deviceChannel: 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_fraudActivity: Recommended for Discover ProtectBuy.
payerAuthEnrollService_giftCardAmount
payerAuthEnrollService_giftCardCount
payerAuthEnrollService_giftCardCurrency
*payerAuthEnrollService_httpAccept: When the customer’s browser provides a value, include that value in your request.
*payerAuthEnrollService_httpUserAccept
*payerAuthEnrollService_httpUserAgent
payerAuthEnrollService_installmentTotal Count: Required when the merchant and cardholder have agreed to installment payments.
payerAuthEnrollService_marketingOptIn: Recommended for Discover ProtectBuy.
payerAuthEnrollService_marketingSource: Recommended for Discover ProtectBuy
.
payerAuthEnrollService_MCC: Required when the card type is Cartes Bancaires.
payerAuthEnrollService_merchantID: 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_merchantFraudRate
payerAuthEnrollService_merchantName: Required for Visa Secure travel.
payerAuthEnrollService_merchantNewCustomer
payerAuthEnrollService_merchantScore: Required for transactions processed in France.
payerAuthEnrollService_merchantURL
payerAuthEnrollService_messageCategory
payerAuthEnrollService_overridePay mentMethod
payerAuthEnrollService_paymentAccount Date: Recommended for Discover ProtectBuy.
payerAuthEnrollService_preorder
payerAuthEnrollService_preorderDate
payerAuthEnrollService_priorAuthenticationData
payerAuthEnrollService_priorAuthentica tionMethod
payerAuthEnrollService_priorAuthentica tionReferenceID
payerAuthEnrollService_priorAuthentica tionTime
payerAuthEnrollService_productCode: Required for American Express SafeKey (U.S.) when the product code is AIR (Airline purchase).
payerAuthEnrollService_recurringEndDate: Required for recurring transactions.
payerAuthEnrollService_recurringFrequency: Required for recurring transactions
.
payerAuthEnrollService_recurringOriginal PurchaseDate: Required for recurring transactions.
payerAuthEnrollService_referenceID: Required for Hybrid or Cardinal Cruise Direct Connection API integration.
payerAuthEnrollService_reorder
payerAuthEnrollService_requestorInitiated AuthenticationIndicator: 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: Required for 3-D Secure 2.x.
payerAuthEnrollService_secureCorporatePay mentIndicator
payerAuthEnrollService_shipAddressUsage Date: Recommended for Discover ProtectBuy.
payerAuthEnrollService_totalOffersCount
payerAuthEnrollService_transactionCount Day: Recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionCount Year: Recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionMode
payerAuthEnrollService_whiteListStatus
payerAuthEnrollService_workPhone
paymentNetworkToken_transactionType
requestID
shipTo_city: Required when any shipping address information is included. Required for American Express SafeKey (U.S.).
shipTo_country: Required only for American Express SafeKey (U.S.).
shipTo_destinationCode
shipTo_firstName
shipTo_lastName
shipTo_middleName
shipTo_phoneNumber
shipTo_destinationTypes: Required when the
bill_country
field value is
US
or
CA
.
shipTo_postalCode: Required when the
shipTo_country
field value is
US
or
CA
. Required for American Express SafeKey (U.S.).
shipTo_shippingMethod: Required only for American Express SafeKey (U.S.).
shipTo_state: Required when the
shipTo_country
field value is
CA
,
US
, or
Mainland China
. Required for American Express SafeKey (U.S.).
shipTo_street1: Required when any shipping address information is included. Required for American Express SafeKey (U.S.).
shipTo_street2: Required only for American Express SafeKey (U.S.).
shipTo_street3: Required for American Express SafeKey (U.S.).