Optional Fields for Enrolling in Payer Authentication

These fields are optional when requesting the Payer Authentication Enrollment service:

acquirerInformation.acquirerBin
acquirerInformation.country
acquirerInformation.merchantId
billTo_passportCountry: Recommended for Discover ProtectBuy.
billTo_passportNumber: Recommended for Discover ProtectBuy.
buyerInformation.mobilePhone
buyerInformation.workPhone
consumerAuthenticationInformation.acsWindowSize
consumerAuthenticationInformation.alternateAuthenticationData
consumerAuthenticationInformation.alternateAuthenticationDate
consumerAuthenticationInformation.alternateAuthenticationMethod
consumerAuthenticationInformation.authenticationTransactionId: Required for Standard integration.
consumerAuthenticationInformation.challengeCode: This field defaults to
01
on your account but is overridden by the merchant when you include this field. EMV 3D Secure version 2.1.0 supports values
01
-
04
. Version 2.2.0 supports values
01
-
09
.
Warning!
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.
consumerAuthenticationInformation.credentialEncrypted
consumerAuthenticationInformation.customerCardAlias: This field is required when tokenization is enabled in the merchant profile settings.
consumerAuthenticationInformation.decoupledAuthenticationIndicator
consumerAuthenticationInformation.decoupledAuthenticationMaxTime
consumerAuthenticationInformation.defaultCard: Recommended for Discover ProtectBuy.
consumerAuthenticationInformation.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
.
consumerAuthenticationInformation.marketingOptIn: Recommended for Discover ProtectBuy.
consumerAuthenticationInformation.marketingSource: Recommended for Discover ProtectBuy.
consumerAuthenticationInformation.mcc: Required when the card type is Cartes Bancaires.
consumerAuthenticationInformation.merchantFraudRate
consumerAuthenticationInformation.merchantScore: Required for transactions processed in France.
consumerAuthenticationInformation.merchantURL
consumerAuthenticationInformation.messageCategory
consumerAuthenticationInformation.otpToken
consumerAuthenticationInformation.overrideCountryCode
consumerAuthenticationInformation.overridePaymentMethod
consumerAuthenticationInformation.paymentAccountDate: Recommended for Discover ProtectBuy.
consumerAuthenticationInformation.preorder
consumerAuthenticationInformation.preorderDate
consumerAuthenticationInformation.priorAuthenticationData
consumerAuthenticationInformation.priorAuthenticationMethod
consumerAuthenticationInformation.priorAuthenticationReferenceId
consumerAuthenticationInformation.priorAuthenticationTime
consumerAuthenticationInformation.productCode
consumerAuthenticationInformation.referenceId
consumerAuthenticationInformation.requestorName
consumerAuthenticationInformation.transactionMode
consumerAuthenticationInformation.scoreRequest
consumerAuthenticationInformation.sdkMaxTimeout
consumerAuthenticationInformation.strongAuthentication.authenticationIndicator
merchantDefinedData_mddField_1 to merchantDefinedData_mddField_5: Important
: 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.

Warning!
: 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.
merchantInformation.merchantDescriptor.name: Required for Visa Secure travel.
orderInformation.billTo.address2
orderInformation.billTo.locality: Required for U.S., Canada, and Mainland China. For U.S. and Canada, use the two-character state, province, or territory codes. For Mainland China, use the ISO 3166-2 format. When the value is not in the correct format, you may experience authentication errors. It is better to not send a value rather than format the value incorrectly.
orderInformation.amountDetails.currency
orderInformation.billTo.locality
orderInformation.billTo.phoneNumber
"orderInformation.billTo.postalCode"
orderInformation.lineItems.passenger.firstName
orderInformation.lineItems.passenger.lastName
orderInformation.lineItems.productDescription
orderInformation.lineItems.productName
orderInformation.lineItems.productSku
orderInformation.lineItems.quantity
orderInformation.lineItems.shippingAddress1
orderInformation.lineItems.shippingAddress2
orderInformation.lineItems.shippingCity
orderInformation.lineItems.shippingCountryCode
orderInformation.lineItems.shippingDestinationTypes
orderInformation.lineItems.shippingLastName
orderInformation.lineItems.shippingMiddleName
orderInformation.lineItems.shippingPhone
orderInformation.lineItems.shippingPostalCode
orderInformation.lineItems.shippingState
orderInformation.lineItems.unitPrice
orderInformation.lineItems[i].giftCardCurrency
orderInformation.lineItems[i].quantity
orderInformation.lineItems[i].totalAmount
orderInformation.lineItems.shippingDestinationTypes
orderInformation.preOrderDate
orderInformation.reordered
orderInformation.shipTo.address1
orderInformation.shipTo.address2
orderInformation.shipTo.address3
orderInformation.shipTo.administrativeArea
orderInformation.shipTo.country
orderInformation.shipTo.destinationCode
orderInformation.shipTo.email
orderInformation.shipTo.firstName
orderInformation.shipTo.lastName
orderInformation.shipTo.middleName
orderInformation.shipTo.locality
orderInformation.shipTo.method
orderInformation.shipTo.postalCode
payerAuthEnrollService_accountPurchases: Recommended for Discover ProtectBuy.
payerAuthEnrollService_fraudActivity: Recommended for Discover ProtectBuy.
payerAuthEnrollService_giftCardAmount
payerAuthEnrollService_giftCardCount
payerAuthEnrollService_giftCardCurrency
payerAuthEnrollService_merchantNewCustomer
payerAuthEnrollService_priorAuthenticationTime
payerAuthEnrollService_productCode: Required for American Express SafeKey (U.S.).
payerAuthEnrollService_recurringEndDate: Required for recurring transactions.
payerAuthEnrollService_recurringFrequency: Required for recurring transactions.
payerAuthEnrollService_recurringOriginalPurchaseDate: When this field is empty, the current date is used.
payerAuthEnrollService_reorder
payerAuthEnrollService_requestorInitiatedAuthenticationIndicator: EMV 3D Secure version 2.1.0 supports values
01
-
05
. Version 2.2.0 supports values
01
-
11
.
payerAuthEnrollService_sdkMaxTimeout: Required for 3D Secure 2.x. When you do not send a value in this field, the value defaults to
15
.
payerAuthEnrollService_secureCorporatePaymentIndicator
payerAuthEnrollService_shipAddressUsageDate: Recommended for Discover ProtectBuy.
payerAuthEnrollService_totalOffersCount
payerAuthEnrollService_transactionCountDay: Recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionCountYear: Recommended for Discover ProtectBuy.
payerAuthEnrollService_transactionMode
payerAuthEnrollService_whiteListStatus
paymentInformation.card.expirationMonth
paymentInformation.card.number
paymentInformation.card.type
recurringPaymentInformation.numberOfPayments: Required when the merchant and cardholder have agreed to installment payments.
riskInformation.buyerHistory.accountPurchases
riskInformation.buyerHistory.addCardAttempts: Recommended for Discover ProtectBuy.
riskInformation.buyerHistory.customerAccount.createDate: Recommended for Discover ProtectBuy.
riskInformation.buyerHistory.customerAccount.lastChangeDate: Recommended for Discover ProtectBuy.
riskInformation.buyerHistory.customerAccount.passwordChangeDate: Recommended for Discover ProtectBuy.
riskInformation.buyerHistory.customerAccount.shipAddressUsageDate
riskInformation.buyerHistory.paymentAccountDate
riskInformation.buyerHistory.priorSuspiciousActivity
riskInformation.buyerHistory.transactionCountDay
riskInformation.buyerHistory.transactionCountYear
shipTo_city: Required for American Express SafeKey (U.S.).
shipTo_country: Required for American Express SafeKey (U.S.).
shipTo_destinationCode
shipTo_destinationTypes: Required when the
bill_country
field value is
US
or
CA
.
shipTo_firstName
shipTo_lastName
shipTo_phoneNumber
shipTo_postalCode: Required when the
shipTo_country
field value is
US
or
CA
. Required for American Express SafeKey (U.S.).
shipTo_shippingMethod: Required for American Express SafeKey (U.S.).
shipTo_state: Required when
shipTo_country
value is
CA
,
US
, or
China
. Required for American Express SafeKey (U.S.).
shipTo_street1: Required for American Express SafeKey (U.S.).
shipTo_street2: Required for American Express SafeKey (U.S.).
travelInformation.legs.carrierCode: Required for each leg. Required for American Express SafeKey (U.S.) for travel-related requests.
travelInformation.legs.departureDate: Required for American Express SafeKey (U.S.) for travel-related requests. The leg destination name must contain 0 instead of #. Payer Authentication services only use the first leg of the trip.
travelInformation.legs.destination: Required for each leg. Required for American Express SafeKey (U.S.) for travel-related requests.
travelInformation.legs.origination: Required for American Express SafeKey (U.S.) for travel-related requests.
travelInformation.numberOfPassengers: When this field is not included in your request, a default value of
1
is used. Required for American Express SafeKey (U.S.) for travel-related requests.
travelInformation.passengers.firstName: Required for American Express SafeKey (U.S.) for travel-related requests.
travelInformation.passengers.lastName: Required for American Express SafeKey (U.S.) for travel-related requests.