To communicate with the Adyen API you should submit HTTP POST requests to corresponding endpoints. These endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the Adyen payments platform.
This document lists all endpoints available for you to integrate with the test platform and run QA checks.
Endpoints
SOAP
For the SOAP messaging protocol, all test payment requests must be posted to the following endpoint:
The data schema for corresponding SOAP objects is available at:
JSON and FORM
This is an overview of the test URL endpoints to communicate with our API using JSON or FORM (key-value parameters passed in an Http POST URL).
After you are ready to go live, you should switch to either generic or custom live endpoints. For more information, refer to Live endpoints.
BankAccount
This object provides fields to hold information on bank account details.
Field | Type | Required | Description |
---|---|---|---|
bankAccountNumber |
String |
![]() |
The bank account number (without separators). |
bankCity |
String | ![]() |
The bank city. |
bankLocationId |
String |
![]() |
The location id of the bank.
The field value is
nil in most cases.
|
bankName |
String |
![]() |
The name of the bank. |
bic |
String |
![]() |
The business identifier code (BIC) is the SWIFT address assigned to a bank.
The field value is
nil in most cases.
|
countryCode |
String |
![]() |
Country code where the bank is located. A valid value is an ISO 2-character country code (e.g. 'NL'). |
iban |
String |
![]() |
The International Bank Account Number (IBAN). |
ownerName |
String |
![]() |
The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:
After replacement, the
If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. |
taxId |
String | ![]() |
Tax identification number. |
Card
A container for card data.
Field | Type | Required | Description |
---|---|---|---|
cvc |
String | ![]() |
The card verification code. Depending on the card brand, it is known also as:
If you are using Client-Side Encryption, the CVC code is present in the encrypted data. You must never post the card details to the server. This field must be always present in a one-click payment request. When this value is returned in a response, it is always empty because it is not stored. |
expiryMonth |
String | ![]() |
The card expiry month. Format: 2 digits, zero-padded for single digits. For example:
|
expiryYear |
String | ![]() |
The card expiry year. Format: 4 digits. For example: 2018. |
holderName |
String | ![]() |
The name of the card holder, as printed on the card. |
issueNumber |
String | ![]() |
The issue number of the card (for some UK debit cards only). |
number |
String | ![]() |
The card number. Do not use any separators.
When this value is returned in a response, only the last 4 digits of the card number are returned. |
startMonth |
String | ![]() |
The month component of the start date (for some UK debit cards only). |
startYear |
String | ![]() |
The year component of the start date (for some UK debit cards only). |
ForexQuote
Holds information on the forex quote as returned in the response of the forex service.
Field | Type | Required | Description |
---|---|---|---|
account |
String | ![]() |
The account name. |
accountType |
String | ![]() |
The account type. |
baseAmount |
Amount | ![]() |
The base amount. |
basePoints |
Int | ![]() |
The base points. |
buy |
Amount | ![]() |
The buy rate. |
interbank |
Amount | ![]() |
The interbank amount. |
reference |
String | ![]() |
The reference assigned to the forex quote request. |
sell |
Amount | ![]() |
The sell rate. |
signature |
String | ![]() |
The signature to validate the integrity. |
source |
String | ![]() |
The source of the forex quote. |
type |
String | ![]() |
The type of forex. |
validTill |
DateTime | ![]() |
The date until which the forex quote is valid. |
FraudCheckResult
Holds results of performing an individual risk check.
Field | Type | Required | Description |
---|---|---|---|
accountScore |
Int | ![]() |
The fraud score generated by the risk check. |
checkId |
Int | ![]() |
The id of the risk check. |
name |
String | ![]() |
The name of the risk check. |
FraudResult
Holds information on the results of a fraud risk check.
Field | Type | Required | Description |
---|---|---|---|
accountScore |
Int | ![]() |
The total fraud score generated by the risk checks. |
results |
Array of FraudCheckResult | ![]() |
The result of the individual risk checks. |
Gift cards
A container for the gift card information.
Field | Type | Required | Description |
---|---|---|---|
cvc |
String | ![]() |
If you choose to ask your shopper for the PIN while making the payment. Use this field to enter the gift card PIN. |
expiryMonth |
String | ![]() |
The gift card expiry month. Format: 2 digits, zero-padded for single digits. For example:
If the card does not contain this value, you can pass dummy values to fulfil the requirement. |
expiryYear |
String | ![]() |
The gift card expiry year. Format: 4 digits. For example, 2018. If the card does not contain this value, you can pass a dummy value to fulfil the requirement. |
holderName |
String | ![]() |
The name of the gift card holder. |
number |
String | ![]() |
The gift card number. Do not use any separators.
|
|
Class | ![]() |
Additional data container. Contains:
Use this object to deactivate a gift card. |
|
String | ![]() |
Expected value: stored_value_redemption_type |
Value |
String | ![]() |
Expected value: deactivate |
ModificationRequest
Represents general parameters used to modify an authorised payment. This request data can be passed as a part of capture, cancel or refund requests (see Payment modifications).
AdjustAuthorisationModificationRequest
To adjust an authorised amount (increase or decrease), send a modification request to the /adjustAuthorisation
endpoint. For more information, refer to Adjust Authorisation.
Field | Type | Required | Description |
---|---|---|---|
merchantAccount |
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed. |
modificationAmount |
Amount | ![]() |
The amount after adjusting. This amount value must be the absolute amount, to which you want to modify the current authorisation. If you want to extend the validity of the authorisation, the value of this field has to be the same as in the original |
originalReference |
String | ![]() |
The
originalReference value corresponds to the
pspReference value assigned to the original payment.
You receive the
|
reference |
String | ![]() |
If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports. Max length: 80 characters.
|
additionalData.industryUsage |
String | ![]() |
Allowed values:
|
CaptureModificationRequest
To capture an authorised payment, send a modification request to the /capture
endpoint.
Field | Type | Required | Description |
---|---|---|---|
additionalData |
Object | ![]() |
This field contains additional data, which may be required for a particular modification request. The |
merchantAccount |
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed. |
modificationAmount |
Amount | ![]() |
The amount to capture.
The
currency must match the currency used in the original payment request.
The |
originalReference |
String | ![]() |
The
originalReference value corresponds to the
pspReference value assigned to the original payment.
You receive the
|
reference |
String | ![]() |
If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports. Max length: 80 characters.
|
CancelModificationRequest
To cancel an authorised payment, send a modification request to the /cancel
endpoint.
Field | Type | Required | Description |
---|---|---|---|
merchantAccount |
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed. |
originalReference |
String | ![]() |
The
originalReference value corresponds to the
pspReference value assigned to the original payment.
You receive the
|
reference |
String | ![]() |
If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports. Max length: 80 characters.
|
CancelOrRefundModificationRequest
To initiate a cancellation or refund of an authorised payment that may or may not have been captured, send a modification request to the /cancelOrRefund
endpoint.
Do not use this request for payments that involve (multiple) partial captures.
Pass the following parameters:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed |
|
String | ![]() |
The transaction reference provided by the PED. |
|
String | ![]() |
Unique terminal ID for the PED that originally processed the request. |
reference |
String | ![]() |
If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports. Max length: 80 characters.
|
additionalData.cancelOrRefundReason |
String | ![]() |
The reason why the cancel or refund is being performed. |
Alternatively, you can implement based on the pspReference
, after it has been generated by the Adyen payments platform:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed |
|
String | ![]() |
The
originalReference value corresponds to the
pspReference value assigned to the original payment.
You receive the
|
reference |
String | ![]() |
If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports. Max length: 80 characters.
|
TechnicalCancelModificationRequest
To cancel an authorised payment with your own reference instead of the PSP reference, send a modification request to the /technicalCancel
endpoint.
Field | Type | Required | Description |
---|---|---|---|
merchantAccount |
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed. |
originalMerchantReference |
String | ![]() |
Your custom reference that you used as a
reference parameter in the original
/authorise request.
|
reference |
String | ![]() |
If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports. Max length: 80 characters.
|
RefundModificationRequest
To initiate a refund of an authorised and captured payment, send a modification request to the /refund
endpoint.
Field | Type | Required | Description |
---|---|---|---|
merchantAccount |
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed. |
modificationAmount |
Amount | ![]() |
A container for the amount that needs to be refunded.
The
currency must match the currency used in the original payment request.
The
|
originalReference |
String | ![]() |
The
originalReference value corresponds to the
pspReference value assigned to the original payment.
You receive the
|
reference |
String | ![]() |
If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports. Max length: 80 characters.
|
VoidPendingRefundModificationRequest
Use the /voidPendingRefund
endpoint to cancel a POS refund request. The default approach uses the tenderReference
, as this is generated in both offline and online transactions.
Pass the following parameters:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String | ![]() |
The merchant account where the transaction, for which the request needs to be initiated, was processed. |
|
String | ![]() |
The transaction reference provided by the PED. |
|
String | ![]() |
Unique terminal ID for the PED that originally processed the request. |
Alternatively, you can implement based on the originalReference
when it has been generated by the Adyen payments platform:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String | ![]() |
The merchant account where the original refund request was processed. |
|
String | ![]() |
The You receive the
|
ModificationRequest.additionalData
The additionalData
object is a generic container that can hold extra request fields. You may require to pass these fields along with payment modification data, for example, to better manage risky transactions or to initiate a payment using some local payment methods.
Depending on your requirements, you can pass the following values as additionalData
in a modification request:
Mastercard UK Installments
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
installmentPaymentData.selectedInstallmentOption
|
Integer | ![]() |
This is the installment option selected by the shopper. It is required only if specified by the user. |
ModificationResult
Contains data returned in response to a modification request. For more information, refer to Payment modifications.
Field | Type | Required | Description |
---|---|---|---|
additionalData |
Object | ![]() |
This field contains additional data, which may be returned in a particular modification response. |
pspReference |
String | ![]() |
Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.
|
response |
String | ![]() |
|
PaymentRequest
The fields described below are the generic payment fields you specify when making an /authorise
call to the Adyen payment API.
Field | Type | Required | Description | |
---|---|---|---|---|
additionalAmount |
Amount | ![]() |
A container for the data concerning the additional amount to be authorised. It corresponds to the additional/surcharged part of the amount, and it needs to be in the same currency as
To be accepted by the schemes, the value specified in the |
|
additionalData |
Object | ![]() |
This field contains additional data, which may be required for a particular payment request. The |
|
amount |
Amount | ![]() |
A container object for the payable amount information for the transaction. For BIN or card verification requests, its value needs to be 0 (zero). |
|
bankAccount |
BankAccount | ![]() |
The details of the bank account, from which the payment should be made from. Either |
|
billingAddress |
Address | ![]() |
The address where to send the invoice. | |
browserInfo |
BrowserInfo | ![]() |
A user's browser information. | |
captureDelayHours |
Int | ![]() |
The delay between the authorisation and scheduled auto capture, specified in hours. | |
card |
Card | ![]() |
A container for card data. Either |
|
dateOfBirth |
String | ![]() |
||
dccQuote |
ForexQuote | ![]() |
The forex quote as returned in the response of the forex service. | |
deliveryAddress |
Address | ![]() |
The address where the purchased goods should be delivered to. | |
deliveryDate |
Date/Time | ![]() |
The date and time the purchased goods should be delivered.
|
|
deviceFingerprint |
String | ![]() |
A string containing a shopper's device fingerprint. For more information, refer to Device fingerprinting. | |
fraudOffset |
Int | ![]() |
An integer value that is added to the normal fraud score. The value can be either positive or negative. |
|
installments |
Installments | ![]() |
Contains information on an installment. For more information, refer to Installments. | |
mcc |
String | ![]() |
The merchant category code (MCC) is a four-digit number which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. The list of MCCs can be found here. |
|
merchantAccount |
String | ![]() |
The merchant account identifier you want to process the (transaction) request with. |
|
merchantOrderReference |
String | ![]() |
This reference allows linking multiple transactions to each other. We strongly recommend you send the |
|
metadata |
Object | ![]() |
Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". |
|
key |
String | ![]() |
Key for the information to be provided. Example: key = 'storeCountry' Maximum length: 20 characters. When exceeding, the "178" error occurs: "Metadata key size exceeds limit". |
|
value |
String | ![]() |
The value associated with the key. Example: value = 'US' Maximum length: 80 characters. When exceeding, the value is truncated to 80 characters with '...' appended to it. |
|
mpiData |
ThreeDSecureData | ![]() |
Authentication data produced by an MPI (Mastercard SecureCode or Verified By Visa). | |
orderReference |
String | ![]() |
The order reference to link multiple partial payments. | |
recurring |
Recurring | ![]() |
The recurring properties of the payment. Specify this property when you want to enable recurring payments. |
|
recurringProcessingModel |
String | ![]() |
V30 This element was added in the version 30. Defines a recurring payment type. Allowed values:
If all your transactions must have the same |
|
reference |
String | ![]() |
A reference to uniquely identify the payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.
If you need to provide multiple references for a transaction, you can enter them in this field. Separate each reference value with a hyphen character ("-"). This field has a length restriction: you can enter max. 80 characters.
|
|
selectedBrand |
String | ![]() |
Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to:
The |
|
selectedRecurringDetail |
String | ![]() |
The recurringDetailReference you want to use for this payment. The value “LATEST” can be used to select the most recently stored recurring detail. |
|
sessionId |
String | ![]() |
A session identifier used to identify a payment session. |
|
shopperEmail |
String | ![]() |
The shopper's email address. We recommend you provide this data, as it is used in velocity fraud checks. |
|
shopperIP |
String | ![]() |
The shopper's IP address. We recommend you provide this data, as it is used in a number of risk checks. For example: number of payment attempts, location based checks. This field is mandatory for some merchants depending on your business model, contact the Support Team for more information. |
|
shopperInteraction |
String | ![]() |
Specifies the following information:
By default, for the web service API Adyen assumes Ecommerce shopper interaction. This field has the following possible values:
|
|
shopperLocale |
String | ![]() |
The combination of a language code and a country code to specify the language to be used in the payment. | |
shopperName |
Name | ![]() |
A shopper's full name and gender (if specified). | |
shopperReference |
String | ![]() |
A shopper's reference for the payment transaction. We recommend you provide this data. This field is required for recurring payments. |
|
shopperStatement |
String | ![]() |
Set this field in your payment request if you want to include a variable shopper statement.
You can include placeholders for the references. For example:
Note:
|
|
socialSecurityNumber |
String | ![]() |
A shopper's social security number. | |
telephoneNumber |
String | ![]() |
A shopper's telephone number. This field is mandatory in case of Secure+ The country code should be preceded with a + sign. |
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 | ![]() |
This parameter determines whether 3D Secure should be used for the payment request. For more information, refer to 3D Secure. Possible values:
If the |
Risk data fields
The following fields are used to perform risk checks:
Name | Type | Required | Description |
---|---|---|---|
riskdata.deliveryMethod |
String | ![]() |
The method to deliver the goods to the shopper. Used in Delivery Method check. |
riskdata.accountCreationDate |
String | ![]() |
The creation date of a shopper account on the merchant's platform. Format: Used in Custom risk checks. |
|
String | ![]() |
This specifies the date when the shopper's account was created. Format: Used in Shopper Account Age check. |
riskdata.externalRiskScore |
String | ![]() |
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 | ![]() |
Usually a boolean representing the fraud risk assessment coming from a system external to Adyen. Used in Custom risk checks. |
riskdata.operatorCode |
String | ![]() |
A code corresponding to a telecom network operator Used in Custom risk checks. |
riskdata.operatorCountry |
String | ![]() |
Country corresponding to the telecom network operator. Usually a two letter country code. Used in Custom risk checks. |
riskdata.operatorName |
String | ![]() |
Name of a telecom network operator e.g. Vodafone, Orange etc. Used in Custom risk checks. |
riskdata.operatorProductCode |
String | ![]() |
Product code of a telecom product. Used in Custom risk checks. |
riskdata.paymentMethod |
String | ![]() |
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 | ![]() |
The number of previous non-fraudulent orders made by a shopper. Format: Numeric Used in Custom risk checks. |
riskdata.referralMethod |
String | ![]() |
The referral method / reason for joining the merchant's platform. Used in Custom risk checks. |
riskdata.referrerUserName |
String | ![]() |
The user name of a member who referred somebody to the merchant's platform. Used in Custom risk checks. |
riskdata.riskProfileId |
String | ![]() |
The id of the risk profile to use instead of the merchant account's currently set risk profile. |
riskdata.secondaryPhoneNumber |
String | ![]() |
A secondary phone number for a user of the merchant's platform. Used in Custom risk checks. |
riskdata.shippingMethod |
String | ![]() |
Name of the shipping method. Used in Custom risk checks. |
riskdata.shopperCountry |
String | ![]() |
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 | ![]() |
Usually a SIM distribution company name e.g. Core, Elite, GK Tel etc. Used in Custom risk checks. |
riskdata.userName |
String | ![]() |
User name of an account on the merchant's platform. Used in Custom risk checks. |
riskdata.userStatus |
String | ![]() |
Usually a user's loyalty status e.g. Gold, Silver etc. Used in Custom risk checks. |
riskdata.browserLanguage |
String | ![]() |
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 |
---|---|---|---|
|
Object | ![]() |
A container for a specific promotion. The <promotionNr> placeholder is replaced with an integer that increments by one unit.It contains the following elements:
|
|
String | ![]() |
Code of the promotion. |
promotionName |
String | ![]() |
Name of the promotion. |
promotionDiscountAmount |
String | ![]() |
The discount amount of the promotion, represented in minor units. |
|
String | ![]() |
|
promotionDiscountPercentage |
String | ![]() |
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 |
---|---|---|---|
|
Object | ![]() |
A container for a specific item. The <itemNr> placeholder is replaced with an integer that increments by one unit.It contains the following elements:
|
|
String | ![]() |
ID of the item. |
productTitle |
String | ![]() |
A text description of the product the invoice line refers to. |
amountPerItem |
String | ![]() |
The price of item<itemNr> in the basket, represented in minor units. |
|
String | ![]() |
|
upc |
String | ![]() |
|
sku |
String | ![]() |
|
brand |
String | ![]() |
Brand of the item. |
manufacturer |
String | ![]() |
Manufacturer of the item. |
category |
String | ![]() |
Category of the item. |
color |
String | ![]() |
Color of the item. |
size |
String | ![]() |
Size of the item. |
quantity |
String | ![]() |
Quantity of the item purchased. |
receiverEmail |
String | ![]() |
Email associated with the given product in the basket (usually in electronic gift cards). |
Retry fields
Field | Type | Required | Description |
---|---|---|---|
retry.chainAttemptNumber |
Integer | ![]() |
The number of times the transaction (not order) has been retried between different payment service providers. For instance, the If you submit |
retry.orderAttemptNumber |
Integer | ![]() |
The index of the attempt to bill a particular order, which is identified by the If you submit |
retry.skipRetry |
Boolean | ![]() |
The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. If you submit |
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.
airline
The top-level container object for all airline data.
Field | Type | Required | Description |
---|---|---|---|
airline.passenger_name
|
String | ![]() |
Passenger name, initials and title name.
|
airline.computerized_reservation_system |
String | ![]() |
The CRS used to make the reservation and purchase the ticket; alphanumeric.
|
airline.airline_code |
String | ![]() |
IATA 3-digit accounting code (PAX); numeric. It identifies the carrier.
|
airline.ticket_number |
String | ![]() |
The ticket's unique identifier.
|
airline.flight_date |
String | ![]() |
Flight departure date. Local time (
|
airline.customer_reference_number |
String | ![]() |
Reference number; alphanumeric.
|
airline.ticket_issue_address |
String | ![]() |
Address of the place/agency that issued the ticket.
|
airline.airline_designator_code |
String | ![]() |
IATA 2-letter accounting code (PAX); alphabetical. It identifies the carrier.
|
airline.travel_agency_code |
String | ![]() |
IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.
|
airline.travel_agency_name |
String | ![]() |
The name of the travel agency.
|
airline.agency_plan_name |
String | ![]() |
2-letter agency plan identifier; alphabetical.
|
airline.agency_invoice_number |
String | ![]() |
Reference number for the invoice, issued by the agency.
|
airline.boarding_fee |
String | ![]() |
Chargeable amount for boarding the plane. The transaction amount needs to be represented in minor units according to the following table.
|
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 | ![]() |
Alphabetical identifier of the departure airport.
|
airline.leg<legNr>.flight_number |
String | ![]() |
The flight identifier.
|
airline.leg<legNr>.carrier_code |
String | ![]() |
|
airline.leg<legNr>.fare_base_code |
String | ![]() |
Fare basis code; alphanumeric.
|
airline.leg<legNr>.class_of_travel |
String | ![]() |
1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:
Limitations:
|
airline.leg<legNr>.stop_over_code |
String | ![]() |
1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:
Limitations:
|
airline.leg<legNr>.destination_code |
String | ![]() |
Alphabetical identifier of the destination/arrival airport.
|
airline.leg<legNr>.date_of_travel |
String |
![]() |
Date and time of travel. ISO 8601-compliant.
|
airline.leg<legNr>.depart_tax |
String |
![]() |
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.
|
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 | ![]() |
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 | ![]() |
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 | ![]() |
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.
|
airline.passenger<passengerNr>.telephone_number |
String | ![]() |
Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.
|
airline.passenger<passengerNr>.date_of_birth |
String | ![]() |
Date of birth of the passenger.
|
Level 2/3 data
The following fields must be provided in additionalData
for commercial cards.


Field | Type | Level 2 | Level 3 | Max. length | Description | |
---|---|---|---|---|---|---|
enhancedSchemeData |
||||||
customerReference |
String | ![]() |
![]() |
25 |
Customer code, if supplied by a customer. Encoding: ASCII. |
|
totalTaxAmount |
Numeric | ![]() |
![]() |
12 | Total tax amount, in minor units. For example, 2000 means USD 20.00 |
|
freightAmount |
Numeric | ![]() |
![]() |
12 | Shipping amount, in minor units. For example, 2000 means USD 20.00 |
|
dutyAmount |
Numeric | ![]() |
![]() |
12 | Duty amount, in minor units. For example, 2000 means USD 20.00 |
|
destinationPostalCode |
String | ![]() |
![]() |
10 |
The postal code of a destination address. Encoding: ASCII. Required for American Express. |
|
destinationStateProvinceCode |
String | ![]() |
![]() |
3 |
Destination state or province code. Encoding: ASCII. |
|
shipFromPostalCode |
String | ![]() |
![]() |
10 |
The postal code of a "ship-from" address. Encoding: ASCII. |
|
destinationCountryCode |
String | ![]() |
![]() |
3 |
Destination country code. Encoding: ASCII. |
|
orderDate |
String | ![]() |
![]() |
6 |
Order date. Format: ddMMyy Encoding: ASCII. |
|
You can submit a maximum of 9 line items. |
||||||
commodityCode |
String | ![]() |
![]() |
12 |
Item commodity code. Encoding: ASCII. |
|
description |
String | ![]() |
![]() |
26 |
Item description. Encoding: ASCII. |
|
productCode |
String | ![]() |
![]() |
12 |
Product code. Encoding: ASCII. |
|
quantity |
Numeric | ![]() |
![]() |
12 |
Quantity, specified as an integer value. Value must be greater than 0. |
|
unitOfMeasure |
![]() |
![]() |
3 |
Item unit of measurement. Encoding: ASCII. |
||
unitPrice |
Numeric | ![]() |
![]() |
12 | Unit price, specified in minor units. | |
discountAmount |
Numeric | ![]() |
![]() |
12 | Discount amount, in minor units. For example, 2000 means USD 20.00 |
|
totalAmount |
Numeric | ![]() |
![]() |
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.
lodging
The top-level container object for all lodging data.
Field | Type | Required | Description |
---|---|---|---|
lodging.customerServiceTollFreeNumber |
String | ![]() |
The toll free phone number for the hotel/lodgings.
|
lodging.checkInDate |
String | ![]() |
The arrival date.
|
lodging.checkOutDate |
String | ![]() |
The departure date.
|
lodging.folioNumber |
String | ![]() |
Card acceptor’s internal invoice or billing ID reference number.
|
lodging.propertyPhoneNumber |
String | ![]() |
Identifies specific lodging property location by its local phone number.
|
lodging.room1.rate |
String | ![]() |
The rate of the room.
|
lodging.room1.tax |
String | ![]() |
The total amount of tax to be paid.
|
lodging.room1.numberOfNights |
String | ![]() |
Total number of nights the room will be rented.
|
lodging.fireSafetyActIndicator |
String | ![]() |
Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.
|
travelEntertainmentAuthData.market
|
String | ![]() |
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.
|
travelEntertainmentAuthData.duration
|
String | ![]() |
Number of nights. This should be included in the auth message.
|
lodging.folioCashAdvances |
String | ![]() |
The folio cash advances.
|
lodging.foodBeverageCharges |
String | ![]() |
Any charges for food and beverages associated with the booking.
|
lodging.noShowIndicator |
String | ![]() |
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). Value should be Y or N.
|
lodging.prepaidExpenses |
String | ![]() |
Prepaid expenses for the booking.
|
lodging.totalTax |
String | ![]() |
Total tax amount.
|
lodging.totalRoomTax |
String | ![]() |
Total room tax amount.
|
Car rental fields
For more information on submitting this data, see Send Travel and Entertainment data.
carRental
The top-level container object for all car rental data.
Field | Type | Required | Description |
---|---|---|---|
carRental.rentalAgreementNumber |
String | ![]() |
The rental agreement number associated with this car rental.
|
carRental.renterName |
String | ![]() |
The name of the person renting the car.
|
carRental.returnCity |
String | ![]() |
The city where the car must be returned.
|
carRental.returnStateProvince |
String | ![]() |
The state or province where the car must be returned.
|
carRental.returnCountry |
String | ![]() |
The country where the car must be returned.
|
carRental.returnLocationId |
String | ![]() |
Agency code, phone number, or address abbreviation
|
carRental.returnDate |
String | ![]() |
The last date to return the car by.
|
carRental.checkOutDate |
String | ![]() |
Pick-up date.
|
carRental.customerServiceTollFreeNumber |
String | ![]() |
The customer service phone number of the car rental company.
|
carRental.rate |
String | ![]() |
Daily rental rate.
|
carRental.rateIndicator |
String | ![]() |
Specifies whether the given rate is applied daily or weekly.
|
carRental.locationCity |
String | ![]() |
The location from which the car is rented.
|
carRental.locationStateProvince |
String | ![]() |
The state or province from which the car is rented.
|
carRental.locationCountry |
String | ![]() |
The country from which the car is rented.
|
carRental.rentalClassId |
String | ![]() |
4-digit code referring to car type.
|
carRental.daysRented |
String | ![]() |
The number of days the car is to be rented.
|
carRental.taxExemptIndicator |
String | ![]() |
Indicates whether the goods or services were tax-exempt, or tax was not collected. Values:
|
travelEntertainmentAuthData.market
|
String | ![]() |
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.
|
travelEntertainmentAuthData.duration
|
String | ![]() |
Number of nights. This should be included in the auth message.
|
carRental.fuelCharges |
String | ![]() |
Any fuel charges associated with the rental.
|
carRental.insuranceCharges |
String | ![]() |
Any insurance charges associated with the rental.
|
carRental.noShowIndicator |
String | ![]() |
Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
|
carRental.oneWayDropOffCharges |
String | ![]() |
Charge associated with not returning a vehicle to the original rental location. |
Open Invoice fields
openinvoicedata
Field |
Type |
Required |
Description |
---|---|---|---|
|
Integer |
![]() |
The number of invoice lines included in There needs to be at least one line, so |
openinvoicedata.merchantData |
String | ![]() |
Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. The 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 | ![]() |
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 |
---|---|---|---|
|
String |
![]() |
The three-character ISO currency code. |
|
String |
![]() |
A text description of the product the invoice line refers to. |
|
Integer |
![]() |
The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded. |
|
Integer |
![]() |
The VAT due for one item in the invoice line, represented in minor units. |
|
Integer |
![]() |
The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900. |
|
String |
![]() |
A unique id for this item. Required for RatePay if the description of each item is not unique. |
|
Integer |
![]() |
The number of units purchased of a specific product. |
|
Enum |
![]() |
The country-specific VAT category a product falls under.
|
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 | ![]() |
Fixed value. This must be the version of the Split API, currently 1. |
|
split.nrOfItems |
String | ![]() |
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 | ![]() |
Total amount of the transaction. Must be equal to the sum of all |
|
split.currencyCode |
String | ![]() |
Currency of the transaction. | |
split.item<ItemNr> |
Object | ![]() |
Container for a specific item. The |
|
amount |
Int | ![]() |
Part of the This |
|
type |
String | ![]() |
Type of the Allowed values:
|
|
account |
String | ![]() |
The code of the account that will receive the amount in the Required if the type field is |
|
reference |
String | ![]() |
Reference for the item. Required if the type field is |
|
description |
String | ![]() |
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) |
![]() |
Amount the customer has to pay each month |
ratepay.lastInstallmentAmount |
Int (long) |
![]() |
Amount of the last installment |
|
Double | ![]() |
Interest rate of this installment |
ratepay.paymentFirstday |
Integer | ![]() |
Calendar day of the first payment |
ratepaydata.invoiceId |
String | ![]() |
Identification name or number for the invoice, defined by the merchant. |
ratepaydata.invoiceDate |
DateTime | ![]() |
Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. |
ratepaydata.deliveryDate |
DateTime | ![]() |
Date the merchant delivered the goods to the customer. |
ratepaydata.dueDate |
DateTime | ![]() |
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 | ![]() |
The Android Pay token retrieved from the SDK. For more information, refer to Google Pay. |
masterpass.transactionId |
String | ![]() |
The Mastercard Masterpass Transaction ID retrieved from the SDK. For more information, refer to Masterpass. |
payment.token |
String | ![]() |
The Apple Pay token retrieved from the SDK. For more information, refer to Apple Pay. |
paywithgoogle.token |
String | ![]() |
The Google Pay token retrieved from the SDK. For more information, refer to Google Pay. |
samsungpay.token |
String | ![]() |
The Samsung Pay token retrieved from the SDK. For more information, refer to Samsung Pay. |
visacheckout.callId |
String | ![]() |
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 | ![]() |
Allowed values:
|
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 | ![]() |
Allowed values:
|
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 | ![]() |
Allowed values:
|
customRoutingFlag
Allows you to determine or override the acquirer account that should be used for the transaction.
Field | Type | Required | Description |
---|---|---|---|
customRoutingFlag |
String | ![]() |
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 | ![]() |
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 |
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 | ![]() |
Customer code, if supplied by a customer.
|
totalTaxAmount | numeric | ![]() |
Total tax amount, in minor units. For example, 2000 means USD 20.00
|
employeeName | String | ![]() |
Name or ID associated with the individual working in a temporary capacity.
|
jobDescription | String | ![]() |
Description of the job or task of the individual working in a temporary capacity.
|
tempStartDate | numeric | ![]() |
Date for the beginning of the pay period. Format: ddMMyy
|
tempWeekEnding | String | ![]() |
Date of the end of the billing cycle. Format: ddMMyy
|
requestName | String | ![]() |
Name of the individual requesting temporary services.
|
regularHoursWorked | numeric | ![]() |
Amount of time worked during a normal operation for the task or job.
|
regularHoursRate | numeric | ![]() |
Amount paid per regular hours worked, minor units.
|
PaymentRequest3d
The fields described below are the generic payment fields you specify when making an /authorise3d
call to the Adyen payment API.
Field | Type | Required | Description | |
---|---|---|---|---|
additionalAmount |
Amount | ![]() |
A container for the data concerning the additional amount to be authorised. It corresponds to the additional/surcharged part of the amount, and it needs to be in the same currency as
To be accepted by the schemes, the value specified in the |
|
additionalData |
Object | ![]() |
This field contains additional data, which may be required for a particular payment request. The |
|
amount |
Amount | ![]() |
A container object for the payable amount information for the transaction. For BIN or card verification requests, its value needs to be 0 (zero).
|
|
billingAddress |
Address | ![]() |
The address where to send the invoice. | |
browserInfo |
BrowserInfo |
A user's browser information. |
||
captureDelayHours |
Int | ![]() |
The delay between the authorisation and scheduled auto-capture, specified in hours. | |
dateOfBirth |
String | ![]() |
||
dccQuote |
ForexQuote | ![]() |
The forex quote as returned in the response of the forex service. | |
deliveryAddress |
Address | ![]() |
The address where the purchased goods should be delivered to. | |
deliveryDate |
Date | ![]() |
The date and time the purchased goods should be delivered.
|
|
deviceFingerprint |
String | ![]() |
A string containing a shopper's device fingerprint. For more information, refer to Device fingerprinting. | |
fraudOffset |
Int | ![]() |
An integer value that is added to the normal fraud score. The value can be either positive or negative. |
|
installments |
Installments | ![]() |
Contains information on an installment. For more information, refer to Installments. | |
md |
String | ![]() |
Payment session identifier returned by the card issuer. |
|
mcc |
String | ![]() |
The merchant category code (MCC) is a four-digit number which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. The list of MCCs can be found here. |
|
merchantAccount |
String | ![]() |
The merchant account identifier you want to process the (transaction) request with. This value must correspond to the |
|
merchantOrderReference |
String | ![]() |
This reference allows linking multiple transactions to each other. When providing the |
|
metadata |
Object | ![]() |
Metadata consists of entries, each of which includes a key and a value. Limitations: Error "177", "Metadata size exceeds limit" |
|
key |
String | ![]() |
Key for the information to be provided. Example: key = 'storeCountry' Limitations: Error "178", "Metadata key size exceeds limit" |
|
value |
String | ![]() |
Information value. Example: value = 'US' Limitations: Maximum length: 80 characters, the value is truncated to 80 characters with '...' appended to it. |
|
orderReference |
String | ![]() |
The order reference to link multiple partial payments. | |
paResponse |
String | ![]() |
Payment authorisation response returned by the card issuer. The |
|
recurring |
Recurring | ![]() |
The recurring properties of the payment. Specify this property when you want to enable recurring payments. |
|
reference |
String | ![]() |
A reference to uniquely identify the payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.
If you need to provide multiple references for a transaction, you can enter them in this field. Separate each reference value with a hyphen character ("-"). This field has a length restriction: you can enter max. 80 characters.
|
|
selectedBrand |
String | ![]() |
Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to:
|
|
selectedRecurringDetailReference |
String | ![]() |
The recurringDetailReference you want to use for this payment. | |
sessionId |
String | ![]() |
A session identifier used to identify a payment session. | |
shopperEmail |
String | ![]() |
The shopper's email address. We recommend you provide this data, as it is used in velocity fraud checks. |
|
shopperIP |
String | ![]() |
The shopper's IP address. We recommend you provide this data, as it is used in a number of risk checks. For example: number of payment attempts, location based checks. |
|
shopperInteraction |
String | ![]() |
Specifies the following information:
By default, for the web service APIAdyen assumes This field has the following possible values:
|
|
shopperLocale |
String | ![]() |
The combination of a language code and a country code to specify the language to be used in the payment. | |
shopperName |
Name | ![]() |
A shopper's full name and gender (if specified). | |
shopperReference |
String | ![]() |
A shopper's reference for the payment transaction. We recommend you provide this data. This field is required for recurring payments. |
|
shopperStatement |
String | ![]() |
Set this field in your payment request if you want to include a variable shopper statement.
You can include placeholders for the references. For example:
Note:
|
|
socialSecurityNumber |
String | ![]() |
A shopper's social security number. | |
telephoneNumber |
String | ![]() |
A shopper's telephone number. |
PaymentRequest3d.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.
For more information on possible key-value pairs in additionalData
, refer to PaymentRequest.additionalData.
Secure+ fields
Field | Type | Required | Description |
---|---|---|---|
mpiImplementationType |
String | ![]() |
In case of Secure+, this field must be set to CUPSecurePlus. |
PaymentResult
If the message passes validation, a risk analysis is performed. Depending on the outcome, an authorisation is attempted and you receive a response with the following fields:
Field | Type | Required | Description |
---|---|---|---|
additionalData |
Object | ![]() |
This field contains additional data, which may be required for a particular payment request. The |
authCode |
String | ![]() |
Authorisation code:
If a payment authorisation response includes |
dccAmount |
Amount | ![]() |
The This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support Team |
dccSignature |
String | ![]() |
Cryptographic signature used to verify This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support Team |
fraudResult |
FraudResult | ![]() |
The fraud result properties of the payment. |
|
String | ![]() |
The URL to direct the shopper to. In case of SecurePlus, do not redirect a shopper to this URL. |
|
String | ![]() |
The payment session. |
|
String | ![]() |
The 3D request data for the issuer. If the value is CUPSecurePlus-CollectSMSVerificationCode, collect an SMS code from the shopper and pass it in the authorise3D request. For more information, see 3D Secure. |
pspReference
|
String | ![]() |
Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.
|
refusalReason |
String | ![]() |
When the payment is not authorised, it is refused, or if an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.
Possible error messages:
When a payment authorisation response includes |
resultCode
|
String | ![]() |
The outcome of the payment. The possible values are:
|
PaymentResult.additionalData
The additionalData
object is a generic container that can hold extra response fields. This functionality is not enabled by default. To specify additionalData
that you want to receive, go to Customer Area > Account > API URLs.
When the additionalData
object is enabled for your merchant account, it can be configured to return the following fields in API responses and/or payment notifications:
Field | Type | Returned by default | Description |
---|---|---|---|
acquirerAccountCode |
String | ![]() |
The status of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer Only relevant for PayPal transactions. |
acquirerCode |
String | ![]() |
The name of the acquirer processing the payment request. Example: TestPmmAcquirer |
acquirerReference |
String | ![]() |
The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9 |
alias |
String | ![]() |
The Adyen alias of the card. Example: H167852639363479 |
aliasType |
String | ![]() |
The type of the card alias. Example: Default |
authCode |
String | ![]() |
Authorisation code:
Example: 58747 |
authorisedAmountCurrency |
String | ![]() |
The currency of the authorised amount, as a three-character ISO currency code. |
authorisedAmountValue |
Int | ![]() |
Value of the amount authorised. This amount is represented in minor units according to the following table. |
avsResult |
String | ![]() |
The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see AVS. |
avsResultRaw |
String | ![]() |
Raw AVS result received from the acquirer, where available. Example: 7
|
bic |
String | ![]() |
|
|
String | ![]() |
The billing address city passed in the payment request. |
|
String | ![]() |
The billing address country passed in the payment request. Example: NL |
|
String | ![]() |
The billing address house number or name passed in the payment request. |
|
String | ![]() |
The billing address postal code passed in the payment request. Example: 1011 DJ |
|
String | ![]() |
The billing address state or province passed in the payment request. Example: NH |
|
String | ![]() |
The billing address street passed in the payment request. |
|
String | ![]() |
The Bank Identification Number of a credit card, which is the first six digits of a card number. Example: 521234 |
|
String | ![]() |
The cardholder name passed in the payment request. |
|
String | ![]() |
The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available. |
cardIssuingCountry |
String | ![]() |
The country where the card was issued. Example: US |
|
String | ![]() |
The currency in which the card is issued, if this information is available. Example: USD |
cardPaymentMethod |
String | ![]() |
The card payment method used for the transaction. Example: amex |
|
String | ![]() |
The last four digits of a card number. Returned only in case of a card payment. |
cavv |
String | ![]() |
The Cardholder Authentication Verification Value for the 3DS authentication session. The returned value is a Base64-encoded 20-byte array. Example: AQIDBAUGBwgJCgsMDQ4PEBESExQ= |
cavvAlgorithm |
String | ![]() |
The algorithm used to generate the 3DS Cardholder Authentication Verification Value. Example: 3 |
countryCode |
String | ![]() |
|
cvcResult |
String | ![]() |
The CVC result code, which provides information about the outcome of the CVC check. For possible cvcResult values, see CVC-CVV result testing. |
cvcResultRaw |
String | ![]() |
Raw CVC result received from the acquirer, where available. Example: 1
|
deliveryAddress.stateOrProvince |
String | ![]() |
The delivery address state or province passed in the payment request. Example: NH |
deliveryAddress.city |
String | ![]() |
The delivery address city passed in the payment request. |
deliveryAddress.postalCode |
String | ![]() |
The delivery address postal code passed in the payment request. Example: 1011 DJ |
deliveryAddress.street |
String | ![]() |
The delivery address street passed in the payment request. |
deliveryAddress.houseNumberOrName |
String | ![]() |
The delivery address house number or name passed in the payment request. |
deliveryAddress.country |
String | ![]() |
The delivery address country passed in the payment request. Example: NL |
eci |
String | ![]() |
The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02 |
expiryDate |
String | ![]() |
The expiry date on the card. Example: 6/2016 Returned only in case of a card payment. |
extraCostsCurrency |
String | ![]() |
The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR |
extraCostsValue |
String | ![]() |
The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units. |
|
String | ![]() |
The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair. |
fundingSource |
String | ![]() |
Information regarding the funding type of the card. The possible return values are:
This functionality requires additional configuration on Adyen's end. To enable it, contact the
Support Team.
For receiving this field in the notification, enable Include Funding Source in Notifications > Additional settings. |
fundsAvailability |
Enum | ![]() |
Indicates availability of funds.
Visa:
Mastercard:
Returned when you verify a card BIN or estimate costs, and only if
|
inferredRefusalReason |
String | ![]() |
Provides the more granular indication of why a transaction was refused.
When a transaction fails with either “Refused", “Restricted Card", "Transaction Not Permitted”, “Not supported” or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason.
If an inferred refusal reason is available, the inferredRefusalReason field is populated and the refusalReason is set to "Not Supported".
Possible values:
|
installments.value |
String | ![]() |
The number of installments that the payment amount should be charged with. Example: 5 Only relevant for card payments in countries that support installments. |
issuerCountry |
String | ![]() |
The issuing country of the card based on the BIN list that Adyen maintains. Example: JP |
ownerName |
String | ![]() |
The owner name of a bank account. Only relevant for SEPA Direct Debit transactions. |
paymentAccountReference |
String | ![]() |
The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters. |
paymentMethodVariant |
String | ![]() |
The Adyen sub-variant of the payment method used for the payment request. For more information, refer to PaymentMethodVariant. Example: mcpro |
payoutEligible |
Enum | ![]() |
Indicates whether a payout is eligible or not for this card.
Visa:
Mastercard:
Returned when you verify a card BIN or estimate costs, and only if
|
paypalPayerStatus |
String | ![]() |
The status of the buyer's PayPal account. Example: unverified Only relevant for PayPal transactions. |
paypalPayerResidenceCountry |
String | ![]() |
The buyer's country of residence. Example: NL Only relevant for PayPal transactions. |
paypalPayerId |
String | ![]() |
The buyer's PayPal ID. Example: LF5HCWWBRV2KL Only relevant for PayPal transactions. |
paypalEmail |
String | ![]() |
The buyer's PayPal account email address. Example: paypaltest@adyen.com Only relevant for PayPal transactions. |
paypalProtectionEligibility |
String | ![]() |
The eligibility for PayPal Seller Protection for this payment. Example: Ineligible Only relevant for PayPal transactions. |
realtimeAccountUpdaterStatus |
String | ![]() |
The response code from the Real Time Account Updater service. Possible return values are:
|
recurring.firstPspReference |
String | ![]() |
The
This functionality requires additional configuration on Adyen's end. To enable it, contact the
Support Team.
|
recurring.recurringDetailReference |
String | ![]() |
The reference that uniquely identifies the recurring detail.
This functionality requires additional configuration on Adyen's end. To enable it, contact the
Support Team.
|
referred |
Boolean | ![]() |
If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true |
refusalReasonRaw |
String | ![]() |
Raw refusal reason received from the acquirer, where available. Example: AUTHORISED |
sepadirectdebit.dateOfSignature |
String | ![]() |
The transaction signature date. Format: Only relevant for SEPA Direct Debit transactions. |
sepadirectdebit.mandateId |
String | ![]() |
Its value corresponds to the Only relevant for SEPA Direct Debit transactions. |
sepadirectdebit.sequenceType |
String | ![]() |
This field can take one of the following values:
Example: OOFF Only relevant for SEPA Direct Debit transactions. |
shopperInteraction |
String | ![]() |
The shopper interaction type of the payment request. Example: Ecommerce |
shopperReference |
String | ![]() |
The shopperReference passed in the payment request. Example: AdyenTestShopperXX |
terminalId |
String | ![]() |
The terminal ID used in a point-of-sale payment. Example: 06022622 |
threeDAuthenticated |
Boolean | ![]() |
A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
|
threeDAuthenticatedResponse |
String | ![]() |
The raw 3DS authentication result from the card issuer. Example: N |
threeDOffered |
Boolean | ![]() |
A Boolean value indicating whether 3DS was offered for this payment. Example: true
|
threeDOfferedResponse |
String | ![]() |
The raw enrollment result from the 3DS directory services of the card schemes. Example: Y |
xid |
String | ![]() |
The 3DS transaction ID of the 3DS session. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. Example: ODgxNDc2MDg2MDExODk5MAAAAAA= |
mcBankNetReferenceNumber |
String | ![]() |
The Contact Support Team to enable this field. |
visaTransactionId |
String | ![]() |
The Contact Support Team to enable this field. |
receiptFreeText |
String | ![]() |
Message to the merchant to be displayed on Terminal/shopper. |
|
String |
Type of installment. The value of |
|
|
String |
Possible values:
|
|
|
Integer |
Total number of installments possible for this payment. |
|
|
Double |
Interest rate for the installment period. |
|
|
Integer |
Installment fee amount in minor units. |
|
|
Double |
Annual interest rate. |
|
|
Integer |
First Installment Amount in minor units. |
|
|
Integer |
Subsequent Installment Amount in minor units. |
|
|
Integer |
Maximum number of installments possible for this payment. |
|
|
Integer |
Minimum number of installments possible for this payment. |
|
|
Integer | ![]() |
Total amount in minor units. |
<Nr> refers to the specific installment option. Options are incremented based on the number of installment options supplied by the Issuer.
Recurring
A container for the type of recurring contract to be retrieved.
Field | Type | Required | Description |
---|---|---|---|
contract |
String | ![]() |
The type of recurring contract to be used. Possible values:
|
ThreeDSecureData
To authorise payments with Adyen using 3D Secure authenticated data, send an /authorise
request with an mpiData
object containing the following parameters. Get the values from the authentication data produced by a 3DS 1.0 MPI (Mastercard SecureCode or Verified By Visa) or a 3DS 2.0 provider.
Field | Type | Required | Description | |||
---|---|---|---|---|---|---|
authenticationResponse |
String | ![]() |
In 3DS 1.0, this is the authentication response if a shopper was redirected. In 3DS 2.0, include this parameter if the transaction goes through a challenge authentication flow. This is the |
|||
cavv |
String | ![]() |
This is the cardholder authentication value (base64 encoded, 20 bytes in a decoded form). | |||
cavvAlgorithm |
String | ![]() |
Include this only for 3DS 1.0. The CAVV algorithm used. | |||
directoryResponse |
String | ![]() |
The enrollment response from the directory server. In 3D Secure 2.0 specifications, this is the |
|||
eci |
String | ![]() |
The electronic commerce indicator. |
|||
xid |
String | ![]() |
The transaction identifier assigned by directory server (base64 encoded, 20 bytes in a decoded form). This is the |
|||
threeDSVersion |
String | ![]() |
Include this only for 3DS 2.0. The current supported version is 2.1.0. |