PaymentRequest.additionalData

The additionalData object is a generic container that can hold extra request fields. You may require to pass these fields along with payment request data, for example, to better manage risky transactions or to initiate a payment using some local payment methods.

3D Secure fields

Field Type Required Description
executeThreeD String (error)

This parameter determines whether 3D Secure should be used for the payment request. For more information, refer to 3D Secure.

Possible values:

  • true – 3D Secure will be used (if the merchant account has this functionality enabled).
  • false – 3D Secure will be disabled.

If the executeThreeD field is not specified, it is still possible to enable 3D Secure by providing the browserInfo parameter. For more information, refer to Dynamic 3D Secure.

Risk data fields

The following fields are used to perform risk checks:

Name Type Required Description
riskdata.deliveryMethod String (error)

The method to deliver the goods to the shopper.

Used in Delivery Method check.

riskdata.accountCreationDate String (error)

The creation date of a shopper account on the merchant's platform.

Format: yyyy-MM-dd HH:mm:ss

Used in Custom risk checks.

riskdata.shopperAccountCreationDate

String (error)

This specifies the date when the shopper's account was created.

Format: yyyy-MM-dd HH:mm:ss.sssZ

Used in Shopper Account Age check.

riskdata.externalRiskScore String (error)

A risk score coming from a system external to Adyen.

Format: Numeric (when used in custom risk checks)

Used in External Risk Score check.

Used in Custom risk checks.

riskdata.externalSuspectedFraud String (error)

Usually a boolean representing the fraud risk assessment coming from a system external to Adyen.

Used in Custom risk checks.

riskdata.operatorCode String (error)

A code corresponding to a telecom network operator

Used in Custom risk checks.

riskdata.operatorCountry String (error)

Country corresponding to the telecom network operator. Usually a two letter country code.

Used in Custom risk checks.

riskdata.operatorName String (error)

Name of a telecom network operator e.g. Vodafone, Orange etc.

Used in Custom risk checks.

riskdata.operatorProductCode String (error)

Product code of a telecom product.

Used in Custom risk checks.

riskdata.paymentMethod String (error)

Represents the payment method as it is understood by the merchant. Does not necessarily have to coincide with the payment method determined by Adyen.

Used in Custom risk checks.

riskdata.previousSuccessfulOrders String (error)

The number of previous non-fraudulent orders made by a shopper.

Format: Numeric

Used in Custom risk checks.

riskdata.referralMethod String (error)

The referral method / reason for joining the merchant's platform.

Used in Custom risk checks.

riskdata.referrerUserName String (error)

The user name of a member who referred somebody to the merchant's platform.

Used in Custom risk checks.

riskdata.secondaryPhoneNumber String (error)

A secondary phone number for a user of the merchant's platform.

Used in Custom risk checks.

riskdata.shippingMethod String (error)

Name of the shipping method.

Used in Custom risk checks.

riskdata.shopperCountry String (error)

The shopper country as determined by the merchant, usually as a 2 letter country code. Does not have to coincide with the Adyen determined shopper country.

Used in Custom risk checks.

riskdata.simDistributor String (error)

Usually a SIM distribution company name e.g. Core, Elite, GK Tel etc.

Used in Custom risk checks.

riskdata.userName String (error)

User name of an account on the merchant's platform.

Used in Custom risk checks.

riskdata.userStatus String (error)

Usually a user's loyalty status e.g. Gold, Silver etc.

Used in Custom risk checks.

riskdata.browserLanguage String (error)

Name of the browser language used by the shopper. Usually a two letter country code (e.g. NL, FR, US etc.)

Used in Custom risk checks.

Promotion content fields

Field Type Required Description

riskdata.promotions.promotion<promotionNr>

Object (error) A container for a specific promotion.
The <promotionNr> placeholder is replaced with an integer that increments by one unit.

It contains the following elements:

  • promotionCode
  • promotionName
  • promotionDiscountAmount
  • promotionDiscountCurrency
  • promotionDiscountPercentage

promotionCode

String (error)

Code of the promotion.

promotionName String (error)

Name of the promotion.

promotionDiscountAmount String (error)

The discount amount of the promotion, represented in minor units.

promotionDiscountCurrency

String (error)

The three-character ISO currency code.

promotionDiscountPercentage String (error)

Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.

e.g. for a promotion discount of 30%, the value of the field should be 30.

Basket content fields

Field Type Required Description

riskdata.basket.item<itemNr>

Object (error) A container for a specific item.
The <itemNr> placeholder is replaced with an integer that increments by one unit.

It contains the following elements:

  • itemID
  • productTitle
  • amountPerItem
  • currency
  • upc
  • sku
  • brand
  • manufacturer
  • category
  • color
  • size
  • quantity

itemID

String (error)

ID of the item.

productTitle String (error)

A text description of the product the invoice line refers to.

amountPerItem String (error)

The price of item<itemNr> in the basket, represented in minor units.

currency

String (error)

The three-character ISO currency code.

upc String (error)

Universal Product Code.

sku String (error)

Stock keeping unit.

brand String (error)

Brand of the item.

manufacturer String (error)

Manufacturer of the item.

category String (error)

Category of the item.

color String (error)

Color of the item.

size String (error)

Size of the item.

quantity String (error)

Quantity of the item purchased.

Retry fields

Field Type Required Description
retry.chainAttemptNumber Integer (error)

The number of times the transaction (not order) has been retried between different payment service providers. For instance, the chainAttemptNumber set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.

If you submit retry.chainAttemptNumber, retry.orderAttemptNumber, and retry.skipRetry values, we also recommend you provide the merchantOrderReference to facilitate linking payment attempts together.

retry.orderAttemptNumber Integer (error)

The index of the attempt to bill a particular order, which is identified by the merchantOrderReference field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.

If you submit retry.chainAttemptNumber, retry.orderAttemptNumber, and retry.skipRetry values, we also recommend you provide the merchantOrderReference to facilitate linking payment attempts together.

retry.skipRetry Boolean (error)

The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.

If you submit retry.chainAttemptNumber, retry.orderAttemptNumber, and retry.skipRetry values, we also recommend you provide the merchantOrderReference to facilitate linking payment attempts together.

Airline fields

All below fields are optional, the Required column indicates whether the fields are required to qualify for the airline-specific interchange programs.

On submission, some fields might be truncated by Adyen due to different scheme requirements.

For more information on submitting this data, see Send Travel and Entertainment data for Visa, Mastercard and American Express.

airline

The top-level container object for all airline data.

Field Type Required Description
airline.passenger_name
String (tick)

Passenger name, initials and title name.

  • Format: last name + first name or initials + title
    Example: FLYER / MARY MS.
  • minLength: 1
  • maxLength: 49
airline.computerized_reservation_system String (tick)

The CRS used to make the reservation and purchase the ticket; alphanumeric.

  • minLength: 4
  • maxLength: 4
airline.airline_code String (tick)

IATA 3-digit accounting code (PAX); numeric. It identifies the carrier.

  • Format: IATA 3-digit accounting code (PAX)
    Example.: KLM = 074
  • minLength: 3
  • maxLength: 3
airline.ticket_number String (tick)

The ticket's unique identifier.

  • minLength: 1
  • maxLength: 150
airline.flight_date String (tick)

Flight departure date.

Local time (HH:mm) is optonal.

  • Date format: yyyy-MM-dd
  • Date and time format: yyyy-MM-dd HH:mm
  • minLength: 10
  • maxLength: 16
airline.customer_reference_number String (error)

Reference number; alphanumeric.

  • minLength: 0
  • maxLength: 20
airline.ticket_issue_address String (error)

Address of the place/agency that issued the ticket.

  • minLength: 0
  • maxLength: 16
airline.airline_designator_code String (error)

IATA 2-letter accounting code (PAX); alphabetical. It identifies the carrier.

  • Format: IATA 2-letter airline code
    Example.: KLM = KL
  • minLength: 2
  • maxLength: 2
airline.travel_agency_code String (error)

IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.

  • minLength: 1
  • maxLength: 8
airline.travel_agency_name String (error)

The name of the travel agency.

  • minLength: 1
  • maxLength: 25
airline.agency_plan_name String (error)

2-letter agency plan identifier; alphabetical.

  • minLength: 2
  • maxLength: 2
airline.agency_invoice_number String (error)

Reference number for the invoice, issued by the agency.

  • minLength: 1
  • maxLength: 6
airline.boarding_fee String (error)

Chargeable amount for boarding the plane.

The transaction amount needs to be represented in minor units according to the following table.

  • minLength: 1
  • maxLength: 18

airline.leg

The second-level container object for leg data. The leg number counter starts at 1 and sequentially increments by 1 unit. Maximum number of supported legs is 10.

Field Type Required Description
airline.leg<legNr>.depart_airport String (tick)

Alphabetical identifier of the departure airport.
This field is required/mandatory if the airline data includes leg details.

  • Format: IATA 3-letter airport code.
    Example: Amsterdam = AMS
  • minLength: 3
  • maxLength: 3
airline.leg<legNr>.flight_number String (tick)

The flight identifier.

  • minLength: 1
  • maxLength: 5
airline.leg<legNr>.carrier_code String (tick)

IATA 2-letter accounting code (PAX); alphabetical. It identifies the carrier.
This field is required/mandatory if the airline data includes leg details.

  • Format: IATA 2-letter airline code
    Example.: KLM = KL
  • minLength: 2
  • maxLength: 2
airline.leg<legNr>.fare_base_code String (tick)

Fare basis code; alphanumeric.

  • minLength: 1
  • maxLength: 7
airline.leg<legNr>.class_of_travel String (tick)

1-letter travel class identifier; alphabetical.

There is no standard; however, the following codes are used rather consistently:

  • F: first class
  • J: business class
  • Y: economy class
  • W: premium economy

Limitations:

  • minLength: 1
  • maxLength: 1
airline.leg<legNr>.stop_over_code String (tick)

1-letter code that indicates whether the passenger is entitled to make a stopover.

Only two types of characters are allowed:

  • O: Stopover allowed
  • X: Stopover not allowed

Limitations:

  • minLength: 1
  • maxLength: 1
airline.leg<legNr>.destination_code String (tick)

Alphabetical identifier of the destination/arrival airport.
This field is required/mandatory if the airline data includes leg details.

  • Format: IATA 3-letter airport code.
    Example: Amsterdam = AMS
  • minLength: 3
  • maxLength: 3
airline.leg<legNr>.date_of_travel

String

(error)

Date and time of travel. ISO 8601-compliant.

  • Format: yyyy-MM-dd HH:mm
  • minLength: 16
  • maxLength: 16
airline.leg<legNr>.depart_tax

String

(error)

Departure tax. Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the following table.

  • minLength: 1
  • maxLength: 12

airline.passenger

The second-level container object for passenger data. The passenger number counter starts at 1 and sequentially increments by 1 unit, maximum number of supported passengers is 10.

Field Type Required Description
airline.passenger<passengerNr>.first_name String (error)

Passenger first name/given name. This field is required/mandatory if the airline data includes passenger details.

This field is required/mandatory if the airline data includes leg details.

airline.passenger<passengerNr>.last_name String (error)

Passenger last name/family name. This field is required/mandatory if the airline data includes passenger details.

This field is required/mandatory if the airline data includes leg details.

airline.passenger<passengerNr>.traveller_type String (error)

Passenger type code (PTC).

IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.

However, several carriers use non-standard codes that can be up to 5 alphanumeric characters.

  • minLength: 3
  • maxLength: 6
airline.passenger<passengerNr>.telephone_number String (error)

Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.

  • minLength: 3
  • maxLength: 30
airline.passenger<passengerNr>.date_of_birth String (error)

Date of birth of the passenger.

  • Date format: yyyy-MM-dd
  • minLength: 10
  • maxLength: 10

Level 2/3 data

The following fields must be provided in additionalData for commercial cards.

(tick) – mandatory (this field must be sent);   (error) – optional (this field can be sent); blank – this field shouldn't be sent. 
Field Type Level 2 Level 3 Max. length Description
enhancedSchemeData
  customerReference String (tick) (tick) 25

Customer code, if supplied by a customer.

Encoding: ASCII.

  totalTaxAmount Numeric (tick) (tick) 12

Total tax amount, in minor units.

For example, 2000 means USD 20.00

  freightAmount Numeric (error) (error) 12

Shipping amount, in minor units.

For example, 2000 means USD 20.00

  dutyAmount Numeric (error) (error) 12

Duty amount, in minor units.

For example, 2000 means USD 20.00

  destinationPostalCode String (error) (error) 10

The postal code of a destination address.

Encoding: ASCII.

Required for American Express.

  destinationStateProvinceCode String (error) (error) 3

Destination state or province code.

Encoding: ASCII.

  shipFromPostalCode String (error) (error) 10

The postal code of a "ship-from" address.

Encoding: ASCII.

  destinationCountryCode String (error) (error) 3

Destination country code.

Encoding: ASCII.

  orderDate String (error) (error) 6

Order date.

Format: ddMMyy

Encoding: ASCII.

enhancedSchemeData.itemDetailLine<Nr>

You can submit a maximum of 9 line items.

  commodityCode String (error) (tick) 12

Item commodity code.

Encoding: ASCII.

  description String (error) (tick) 26

Item description.

Encoding: ASCII.

  productCode String (error) (tick) 12

Product code.

Encoding: ASCII.

  quantity Numeric (error) (tick) 12

Quantity, specified as an integer value.

Value must be greater than 0.

  unitOfMeasure   (error) (tick) 3

Item unit of measurement.

Encoding: ASCII.

  unitPrice Numeric (error) (tick) 12 Unit price, specified in minor units.
  discountAmount Numeric (error) (error) 12

Discount amount, in minor units.

For example, 2000 means USD 20.00

  totalAmount Numeric (error) (tick) 12

Total amount, in minor units.

For example, 2000 means USD 20.00

Lodging fields

For more information on submitting this data, see Send Travel and Entertainment data for Visa, Mastercard and American Express.

lodging

The top-level container object for all lodging data.

Field Type Required Description
lodging.customerServiceTollFreeNumber String (tick)

The toll free phone number for the hotel/lodgings.

  • Format: Alphanumeric
  • maxLength: 17
lodging.checkInDate String (tick)

The arrival date.

  • Date format: yyyyMMdd
lodging.checkOutDate String (tick)

The departure date.

  • Date format: yyyyMMdd
lodging.folioNumber String (tick)

Card acceptor’s internal invoice or billing ID reference number.

  • Format: Alphanumeric
  • maxLength: 25
lodging.propertyPhoneNumber String (tick)

Identifies specific lodging property location by its local phone number.

  • Format: Alphanumeric
  • maxLength: 17
lodging.room1.rate String (tick)

The rate of the room.

  • Format: Numeric
  • maxLength: 12
lodging.room1.tax
String (tick)

The total amount of tax to be paid.

  • Format: Numeric
  • maxLength: 12
lodging.room1.numberOfNights  String (tick)

Total number of nights the room will be rented.

  • Format: Numeric
  • maxLength: 4
lodging.fireSafetyActIndicator String (tick)

Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.

  • Format: Alphabetic
  • maxLength: 1
travelEntertainmentAuthData.market
String (tick) Indicates what market-specific dataset will be submitted or is being submitted. Value should be "H" for Hotel. This should be included in the auth message.
  • Format: Alphanumeric
  • maxLength: 1
travelEntertainmentAuthData.duration
String (tick) Number of nights.  This should be included in the auth message.
  • Format: Numeric
  • maxLength: 2
lodging.folioCashAdvances String (error)

The folio cash advances.

  • Format: Numeric
  • maxLength: 12
lodging.foodBeverageCharges String (error)

Any charges for food and beverages associated with the booking.

  • Format: Numeric
  • maxLength: 12
lodging.noShowIndicator String (error)

Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).

Value should be Y or N.

  • Format: Numeric
  • maxLength: 1
lodging.prepaidExpenses String (error) Prepaid expenses for the booking.
  • Format: Numeric
  • maxLength: 12
lodging.totalTax String (error)

Total tax amount.

  • Format: Numeric
  • maxLength: 12

Car rental fields

For more information on submitting this data, see Send Travel and Entertainment data for Visa, Mastercard and American Express.

carRental

The top-level container object for all car rental data.

Field Type Required Description
carRental.rentalAgreementNumber String (tick)

The rental agreement number associated with this car rental.

  • Format: Alphanumeric
  • maxLength: 14
carRental.renterName String (tick)

The name of the person renting the car.

  • Format: Alphanumeric
  • maxLength: 26
carRental.returnCity String (tick)

The city where the car must be returned.

  • Format: Alphanumeric
  • maxLength: 18
carRental.returnStateProvince String (tick)

The state or province where the car must be returned.

  • Format: Alphanumeric
  • maxLength: 3
carRental.returnCountry String (tick)

The country where the car must be returned.

  • Format: Alphanumeric
  • maxLength: 2
carRental.returnLocationId String (tick)

Agency code, phone number, or address abbreviation

  • Format: Alphanumeric
  • maxLength: 10
carRental.returnDate String (tick)

The last date to return the car by.

  • Date format: yyyyMMdd
carRental.checkOutDate String (tick)

Pick-up date.

  • Date format: yyyyMMdd
carRental.customerServiceTollFreeNumber String (tick)

The customer service phone number of the car rental company.

  • Format: Alphanumeric
  • maxLength: 17
carRental.rate String (tick)

Daily rental rate.

  • Format: Alphanumeric
  • maxLength: 12
carRental.rateIndicator String (tick)

Specifies whether the given rate is applied daily or weekly.

  • D - Daily rate.
  • W - Weekly rate.
carRental.locationCity String (tick)

The location from which the car is rented.

  • Format: Alphanumeric
  • maxLength: 18
carRental.locationStateProvince String (tick)

The state or province from which the car is rented.

  • Format: Alphanumeric
  • maxLength: 3
carRental.locationCountry String (tick)

The country from which the car is rented.

  • Format: Alphanumeric
  • maxLength: 2
carRental.rentalClassId String (tick)

4-digit code referring to car type.

  • Format: Alphanumeric
  • maxLength: 4
carRental.daysRented String (tick)

The number of days the car is to be rented.

  • Format: Alphanumeric
  • maxLength: 4
carRental.taxExemptIndicator String (tick)

Indicates whether the goods or services were tax-exempt, or tax was not collected.

Values:

  • 0 - Tax was not collected
  • 1 - Goods or services were tax exempt
travelEntertainmentAuthData.market
String (tick) Indicates what market-specific dataset will be submitted or is being submitted. Value should be "A" for Car rental. This should be included in the auth message.
  • Format: Alphanumeric
  • maxLength: 1
travelEntertainmentAuthData.duration
String (tick) Number of nights.  This should be included in the auth message.
  • Format: Numeric
  • maxLength: 2
carRental.fuelCharges String (error)

Any fuel charges associated with the rental.

  • Format: Numeric
  • maxLength: 12
carRental.insuranceCharges String (error)

Any insurance charges associated with the rental.

  • Format: Numeric
  • maxLength: 12
carRental.noShowIndicator String (error)

Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).

  • 0 - Not applicable.
  • 1 - Customer was a no show.
carRental.oneWayDropOffCharges String (error) Charge associated with not returning a vehicle to the original rental location.

Open Invoice fields

openinvoicedata

Field

Type

Required

Description

openinvoicedata.numberOfLines

Integer

(tick)

The number of invoice lines included in openinvoicedata.

There needs to be at least one line, so numberOfLines needs to be at least 1.

openinvoicedata.merchantData String (error)

Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.

The merchantData parameter needs to be added to the openinvoicedata signature at the end.

Since the field is optional, if it's not included it does not impact computing the merchant signature.

Applies only to Klarna.

You can contact Klarna for the format and structure of the string.

openinvoicedata.installmentConfigurationKey String (error) Required for the Klarna account, identifying an installment plan. Include Klarna’s pclassid for the installment plan.

openinvoicedata.line

A container for a specific line.

The <lineNr> placeholder is replaced with an integer that increments by one unit.

Field

Type

Required

Description

openinvoicedata.line<lineNr>.currencyCode

String

(tick)

The three-character ISO currency code.

openinvoicedata.line<lineNr>.description

String

(tick)

A text description of the product the invoice line refers to.

openinvoicedata.line<lineNr>.itemAmount

Integer
(long)

(tick)

The price for one item in the invoice line, represented in minor units.

The due amount for the item, VAT excluded.

openinvoicedata.line<lineNr>.itemVatAmount

Integer
(long)

(tick)

The VAT due for one item in the invoice line, represented in minor units.

openinvoicedata.line<lineNr>.itemVatPercentage

Integer
(long)

(tick)

The VAT percentage for one item in the invoice line, represented in minor units.

For example, 19% VAT is specified as 1900.

openinvoicedata.line<lineNr>.itemId

String

(error)

A unique id for this item. Required for RatePay if the description of each item is not unique.

openinvoicedata.line<lineNr>.numberOfItems

Integer

(tick)

The number of units purchased of a specific product.

openinvoicedata.line<lineNr>.vatCategory

Enum

(tick)

The country-specific VAT category a product falls under.
Allowed values:

  • High
  • Low
  • None

Split payment fields

With these calls you can split a shopper's payment between several accounts of an account holder, with your marketplace's commission and payment fee. These calls are similar to standard authorise/capture/refund calls, but should also contain additionalData with information how to split a payment. For more information, refer to Processing payments.

If any of the fields provided in additionalData is not validated/correct, the MarketPay system ignores it silently and processes the payment request without additional data.

Field Type Required Description
split.api String (tick)

Fixed value.

This must be the version of the Split API, currently 1.

split.nrOfItems String (tick)

The number of Split Items is how many pieces the payment is split into.

The value specified needs to match the number of Split Items in the request.

split.totalAmount Int (tick)

Total amount of the transaction.

Must be equal to the sum of all item<ItemNr>.amount fields and the amount of the transaction.

split.currencyCode String (tick) Currency of the transaction.
split.item<ItemNr> Object (tick)

Container for a specific item. The <ItemNr> placeholder is replaced with an integer (starting with one) that increments by one unit.

  amount Int (tick)

Part of the totalAmount to be split for this item.

This amount needs to be represented in minor units according to the following table.
Some currencies do not have decimal points, such as JPY, and some have 3 decimal points, such as BHD.
For example, 10 GBP is submitted as 1000, whereas 10 JPY is submitted as 10.

  type String (tick)

Type of the account.

Allowed values:

  • Default – the amount is sent to a marketplace account by default.
  • MarketPlace – indicates that the amount should be sent to an account.
  • Commission – a marketplace's commission, which is specified by the amount field, should be sent to a marketplace.
  • PaymentFee – a payment fee, which is specified by the  amount  field, should be sent to a marketplace.
  • VAT – the tax amount, which is sent to a marketplace account.
  account String (error)

The code of the account that will receive the amount in the split item. This is the accountCode value that you receive in the response when you create an account or an account holder.

Required if the type field is MarketPlace.

  reference String (error)

Reference for the item.

Required if the type field is MarketPlace.

  description  String  (error)  Description of the Split item.

Ratepay fields

These fields should be used within the additionalData field. For more information on submitting additionalData see the PaymentRequest.additionalData topic.

Field Type Required Description
ratepay.installmentAmount

Int (long)

(tick)

Amount the customer has to pay each month

ratepay.lastInstallmentAmount

Int (long)

(tick)

Amount of the last installment

ratepay.interestRate

Double (tick)

Interest rate of this installment

ratepay.paymentFirstday Integer (error) Calendar day of the first payment
ratepaydata.invoiceId String (error) Identification name or number for the invoice, defined by the merchant.
ratepaydata.invoiceDate DateTime (error) Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.
ratepaydata.deliveryDate DateTime (error) Date the merchant delivered the goods to the customer.
ratepaydata.dueDate DateTime (error) Date by which the customer must settle the payment.

Wallet fields

Additional data that should be passed along with the /authorise request for wallet payment methods.

Field Type Required Description
androidpay.token String (error) The Android Pay token retrieved from the SDK. For more information, refer to Google Pay.
masterpass.transactionId String (error) The Mastercard Masterpass Transaction ID retrieved from the SDK. For more information, refer to Masterpass.
payment.token String (error)

The Apple Pay token retrieved from the SDK. For more information, refer to Apple Pay.

paywithgoogle.token String (error) The Google Pay token retrieved from the SDK. For more information, refer to Google Pay.
samsungpay.token String (error) The Samsung Pay token retrieved from the SDK. For more information, refer to Samsung Pay.
visacheckout.callId String (error) The Visa Checkout Call ID retrieved from the SDK. For more information, refer to Visa Checkout.

RequestedTestErrorResponseCode

Triggers test scenarios that allow to replicate certain communication errors.

Field Type Required Description
RequestedTestErrorResponseCode String (error)

Allowed values:

  • NO_CONNECTION_AVAILABLE – There wasn't a connection available to service the outgoing communication.
    This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.
  • IOEXCEPTION_RECEIVED – Something went wrong during transmission of the message or receiving the response.
    This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.

authorisationType

Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to Card authorisation types.

Field Type Required Description
authorisationType String (error)

Allowed values:

  • PreAuth – flags the payment request to be handled as a pre-authorisation.
  • FinalAuth – flags the payment request to be handled as a final authorisation.

mcAuthorisationType

Flags a Mastercard payment request for either pre-authorisation or final authorisation.

If you are implementing this parameter for the first time, use authorisationType instead. The mcAuthorisationType parameter will be deprecated in future versions of the API.

Field Type Required Description
mcAuthorisationType String (error)

Allowed values:

  • PreAuth: flags the payment request to be handled as a pre-authorisation.
  • FinalAuth: flags the payment request to be handled as a final authorisation.

customRoutingFlag

Allows you to determine or override the acquirer account that should be used for the transaction.

Field Type Required Description
customRoutingFlag String (error)

If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.

To enable this functionality, contact the Support Team.

networkTxReference

Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.

Currently, can be used for Visa card payments only.

Field Type Required Description
networkTxReference String (error)

Provide this value in a payment request if you are performing a ContAuth transaction over a tokenized PAN that is stored in your system. It allows the issuer to link the ContAuth transaction to the previous ContAuth transaction or the initial recurring transaction in the chain.

Note that this must be a valid reference received in the previous/original transaction as visaTransactionId value. For more information on this field, refer to PaymentResult.additionalData.

Temporary Services fields

For more information on submitting this data, see Send Level 2/3 data for commercial cards.

The top-level container object for all lodging data.

Field Type Required Description
customerReference String (tick)

Customer code, if supplied by a customer.
Encoding: ASCII.

  • maxLength: 25
totalTaxAmount numeric (tick)

Total tax amount, in minor units. For example, 2000 means USD 20.00

  • maxLength: 12
employeeName String (tick)

Name or ID associated with the individual working in a temporary capacity.

  • maxLength: 40
jobDescription String (tick)

Description of the job or task of the individual working in a temporary capacity.

  • maxLength: 40
tempStartDate numeric (tick)

Date for the beginning of the pay period.

Format: ddMMyy

  • maxLength: 6
tempWeekEnding String (tick)

Date of the end of the billing cycle.

Format: ddMMyy

  • maxLength: 6
requestName String (tick)

Name of the individual requesting temporary services.

  • maxLength: 40
regularHoursWorked numeric (tick)

Amount of time worked during a normal operation for the task or job.

  • maxLength: 7
regularHoursRate numeric (tick)

Amount paid per regular hours worked, minor units.

  • maxLength: 7