REST API

Required Fields for Checking Enrollment in Payer Authentication

These fields are required when requesting the Payer Authentication Enrollment service:
acquirerInformation.merchantId
clientReferenceInformation.code
consumerAuthenticationInformation.customerCCAlias
Required if tokenization is enabled in the merchant profile settings.
consumerAuthenticationInformation.deviceChannel
Required for SDK integration.
consumerAuthenticationInformation.productCode
Required for American Express SafeKey (U.S.) when the product code is
AIR
(Airline purchase).
consumerAuthenticationInformation.referenceID
consumerAuthenticationInformation.returnURL
consumerAuthenticationInformation.sdkMaxTimeout
Required for 3-D Secure 2.x.
deviceInformation.httpAcceptBrowserValue
When the customer’s browser provides a value, you must include that value in your request.
deviceInformation.httpAcceptContent
deviceInformation.httpBrowserColorDepth
deviceInformation.httpBrowserJavaEnabled
deviceInformation.httpBrowserJavaScriptEnabled
deviceInformation.httpBrowserLanguage
deviceInformation.httpBrowserScreenHeight
deviceInformation.httpBrowserScreenWidth
deviceInformation.httpBrowserTimeDifference
deviceInformation.ipAddress
deviceInformation.userAgentBrowserValue
When the customer’s browser provides a value, you must include that value in your request.
merchantInformation.merchantDescriptor.name
Required for Visa Secure travel.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Optional when you use the
orderInformation.lineItems.unitPrice
field.
orderinformation.billTo.administrativeArea
Required for U.S., Canada, and Mainland China. For Mainland China, use the ISO 3166-2 format.
orderinformation.billTo.country
orderinformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderinformation.billTo.locality
orderinformation.billTo.postalCode
Required when the
orderInformation.shipTo.country
field is
US
or
CA
.
orderInformation.lineItems.unitPrice
Optional when the
orderInformation.amountDetails.totalAmount
field is used.
orderInformation.shipTo.addess1
Required when any shipping address information is included. Required only for American Express SafeKey (U.S.).
orderInformation.shipTo.address2
Required only for American Express SafeKey (U.S.).
orderInformation.shipTo.administrativeArea
Required when the
orderInformation.shipTo.country
field value is
CA
,
US
, or
China
. Required only for American Express SafeKey (U.S.).
orderInformation.shipTo.country
Required only for American Express SafeKey (U.S.).
orderInformation.shipTo.Method
Required only for American Express SafeKey (U.S.).
orderInformation.shipTo.postalCode
Required if the
orderInformation.shipTo.country
field value is
US
or
CA
. Required for American Express SafeKey (U.S.).
payerAuthEnrollService_run
paymentInformation.card.expirationMonth
paymentInformation.card.expirationYear
paymentInformation.card.number
paymentInformation.card.Type
paymentInformation.fluidData.value
recurringPaymentInformation.endDate
Required for recurring transactions.
recurringPaymentInformation.originalPurchaseDate
Required for recurring transactions.
recurringPaymentInformation.recurringFrequency
Required for recurring transactions.
travelinformation.legs.carrierCode
travelinformation.legs.departureDate
The numbered element name should contain 0 instead of #. Payer Authentication services only use the first leg of the trip.
travelinformation.legs.destination
Required for each leg.
travelinformation.legs.origination
travelinformation.numberOfPassengers
travelinformation.passengers.firstName
travelinformation.passengers.lastName