POST /payments

Default value: "application/json"

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Contains installment settings. For more information, refer to Installments.

Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later. Used for card installments in Mexico

The installment plan, used for card installments in Japan. and Mexico. By default, this is set to regular.

Possible values:

• "regular"
• "interes_refund_prctg"
• "buynow_paylater"
• "interest_bonus"
• "revolving"
• "refund_prctg"
• "nointeres_refund_prctg"
• "with_interest"
• "nointerest_bonus"

Defines the number of installments. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. This value can be zero for Installments processed in Mexico.

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

Your reference must not include personally identifiable information (PII), for example name or email address.

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.

A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.

Metadata consists of entries, each of which includes a key and a value. Limits:

• Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".
• Maximum 20 characters per key.
• Maximum 80 characters per value.

Set to true if the payment should be routed to a trusted MID.

The merchant account identifier, with which you want to process the transaction.

This field contains additional data, which may be required for a particular payment request.

The additionalData object consists of entries, each of which includes the key and value.

The combination of a language code and a country code to specify the language to be used in the payment.

Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values:

• Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.
• CardOnFile – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.
• UnscheduledCardOnFile – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.

Possible values:

• "CardOnFile"
• "Subscription"
• "UnscheduledCardOnFile"

Specifies the redirect method (GET or POST) when redirecting to the issuer.

When true and shopperReference is provided, the shopper will be asked if the payment details should be stored for future one-click payments.

The order information required for partial payments.

The pspReference that belongs to the order.

The encrypted order data.

Specifies the redirect method (GET or POST) when redirecting back from the issuer.

An array of objects specifying how to split a payment when using Adyen for Platforms, Classic Platforms integration, or Issuing.

The unique identifier of the account to which the split amount is booked. Required if type is MarketPlace or BalanceAccount.

• Classic Platforms integration: The accountCode of the account to which the split amount is booked.
• Balance Platform: The balanceAccountId of the account to which the split amount is booked.

Your description for the split item.

The amount of the split item.

• Required for all split types in the Classic Platforms integration.
• Required if type is BalanceAccount, Commission, Default, or VAT in your Balance Platform integration.

The value of the split amount, in minor units.

The three-character ISO currency code. By default, this is the original payment currency.

The part of the payment you want to book to the specified account.

Possible values for the Balance Platform:

• BalanceAccount: books part of the payment (specified in amount) to the specified account.
• Transaction fees types that you can book to the specified account:
  • AcquiringFees: the aggregated amount of the interchange and scheme fees.
  • PaymentFee: the aggregated amount of all transaction fees.
  • AdyenFees: the aggregated amount of Adyen's commission and markup fees.
  • AdyenCommission: the transaction fees due to Adyen under blended rates.
  • AdyenMarkup: the transaction fees due to Adyen under Interchange ++ pricing.
  • Interchange: the fees paid to the issuer for each payment made with the card network.
  • SchemeFee: the fees paid to the card scheme for using their network.
• Commission: your platform's commission on the payment (specified in amount), booked to your liable balance account.
• Remainder: the amount left over after a currency conversion, booked to the specified account.
• TopUp: allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods.
• VAT: the value-added tax charged on the payment, booked to your platforms liable balance account.
• Commission: your platform's commission (specified in amount) on the payment, booked to your liable balance account.
• Default: in very specific use cases, allows you to book the specified amount to the specified account. For more information, contact Adyen support.

Possible values for the Classic Platforms integration: Commission, Default, MarketPlace, PaymentFee, VAT.

Possible values:

• "MarketPlace"
• "SchemeFee"
• "Surcharge"
• "Commission"
• "PaymentFee"
• "AdyenCommission"
• "Tip"
• "AdyenMarkup"
• "Remainder"
• "Interchange"
• "AcquiringFees"
• "AdyenFees"
• "BalanceAccount"
• "Default"
• "VAT"

Your unique reference for the part of the payment booked to the specified account.

This is required if type is MarketPlace (Classic Platforms integration) or BalanceAccount (Balance Platform).

For the other types, we also recommend providing a unique reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.

Data for 3DS authentication.

Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including Dynamic 3D Secure settings.

Possible values:

• always: Perform 3D Secure authentication.
• never: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.

Possible values:

• "never"
• "always"

Object with additional parameters for the 3D Secure authentication flow.

Indicates if native 3D Secure authentication should be used when available.

Possible values:

• preferred: Use native 3D Secure authentication when available.
• disabled: Only use the redirect 3D Secure authentication flow.

Possible values:

• "preferred"
• "disabled"

The version of 3D Secure to use.

Possible values:

• 2.1.0
• 2.2.0

Possible values:

• "2.1.0"
• "2.2.0"

Flag for data only flow.

Possible values:

• "false"
• "true"

Dimensions of the 3DS2 challenge window to be displayed to the cardholder.

Possible values:

• 01 - size of 250x400
• 02 - size of 390x400
• 03 - size of 500x600
• 04 - size of 600x400
• 05 - Fullscreen

Possible values:

• "05"
• "04"
• "03"
• "02"
• "01"

If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation. Default: false.

Default value: false

When true and shopperReference is provided, the payment details will be tokenized for payouts.

The forex quote as returned in the response of the forex service.

The base points.

The signature to validate the integrity.

The source of the forex quote.

The account name.

The sell rate.

The amount of the transaction, in minor units.

The three-character ISO currency code.

The date until which the forex quote is valid.

The base amount.

The amount of the transaction, in minor units.

The three-character ISO currency code.

The type of forex.

The buy rate.

The amount of the transaction, in minor units.

The three-character ISO currency code.

The reference assigned to the forex quote request.

The account type.

The interbank amount.

The amount of the transaction, in minor units.

The three-character ISO currency code.

Additional risk fields for 3D Secure 2.

For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.

For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

For prepaid or gift card purchase, ISO 4217 three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification.

Indicates whether the cardholder is reordering previously purchased merchandise.

Indicator for whether the shopper has already purchased the same items in the past.

For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).

The amount of the transaction, in minor units.

The three-character ISO currency code.

For pre-order purchases, the expected date this product will be available to the shopper.

Indicator regarding the delivery address. Allowed values:

• shipToBillingAddress
• shipToVerifiedAddress
• shipToNewAddress
• shipToStore
• digitalGoods
• goodsNotShipped
• other

Possible values:

• "digitalGoods"
• "shipToBillingAddress"
• "other"
• "shipToStore"
• "goodsNotShipped"
• "shipToVerifiedAddress"
• "shipToNewAddress"

Whether the chosen delivery address is identical to the billing address.

The delivery email address (for digital goods).

For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters.

Indicator for whether this transaction is for pre-ordering a product.

The estimated delivery time for the shopper to receive the goods. Allowed values:

• electronicDelivery
• sameDayShipping
• overnightShipping
• twoOrMoreDaysShipping

Possible values:

• "overnightShipping"
• "twoOrMoreDaysShipping"
• "electronicDelivery"
• "sameDayShipping"

Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

Indicates shipping method chosen for the transaction.

If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation.

Default value: false

The reference to uniquely identify a 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, separate them with hyphens ("-"). Maximum length: 80 characters.

Price and product information about the purchased items, to be included on the invoice sent to the shopper.

This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, Riverty, and Zip.

Size of the item.

Description of the line item.

Brand of the item.

Tax amount, in minor units.

Number of items.

Link to the purchased item.

Item amount excluding the tax, in minor units.

Link to the picture of the purchased item.

Marketplace seller id.

ID of the line item.

Item amount including the tax, in minor units.

Item category, used by the payment methods PayPal and Ratepay.

Email associated with the given product in the basket (usually in electronic gift cards).

Stock keeping unit.

Manufacturer of the item.

Tax percentage, in minor units.

Universal Product Code.

Color of the item.

Defines how to book chargebacks when using Adyen for Platforms.

The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account.

The unique identifier of the balance account against which the disputed amount is booked.

Required if behavior is deductFromOneBalanceAccount.

The method of handling the chargeback.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.

Possible values:

• "deductAccordingToSplitRatio"
• "deductFromOneBalanceAccount"
• "deductFromLiableAccount"

This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

We strongly recommend you send the merchantOrderReference value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide retry.orderAttemptNumber, retry.chainAttemptNumber, and retry.skipRetry values in PaymentRequest.additionalData.

The address where the purchased goods should be delivered.

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.

The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

The number or name of the house. Maximum length: 3000 characters.

The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

The name of the city. Maximum length: 3000 characters.

The shopper's browser information.

For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the userAgent and acceptHeader fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.

Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.

Default value: true

The total width of the shopper's device screen in pixels.

Time difference between UTC time and the shopper's browser local time, in minutes.

The total height of the shopper's device screen in pixels.

The accept header value of the shopper's browser.

The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.

Boolean value indicating if the shopper's browser is able to execute Java.

The navigator.language value of the shopper's browser (as defined in IETF BCP 47).

The user agent value of the shopper's browser.

The date and time the purchased goods should be delivered.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

Example: 2017-07-17T13:42:40.428+01:00

The delay between the authorisation and scheduled auto-capture, specified in hours.

The date and time the purchased goods should be delivered.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

Example: 2017-07-17T13:42:40.428+01:00

The type of the entity the payment is processed for.

Possible values:

• "CompanyName"
• "NaturalPerson"

Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to Online payments or Classic integration documentation.

Completion indicator for the device fingerprinting.

The sdkEphemPubKey value as received from the 3D Secure 2 SDK.

The kty value as received from the 3D Secure 2 SDK.

The crv value as received from the 3D Secure 2 SDK.

The x value as received from the 3D Secure 2 SDK.

The y value as received from the 3D Secure 2 SDK.

The sdkReferenceNumber value as received from the 3D Secure 2 SDK.

Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values:

• 01 — Goods/Service Purchase
• 03 — Check Acceptance
• 10 — Account Funding
• 11 — Quasi-Cash Transaction
• 28 — Prepaid Activation and Load

Possible values:

• "11"
• "10"
• "28"
• "03"
• "01"

Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly authentication-only integrations. The mcc is a four-digit code with which the previously given acquirerMerchantID is registered at the scheme.

Required for authentication-only integration for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.

Date after which no further authorisations shall be performed. Format: YYYYMMDD

Indicates whether a challenge is requested for this transaction. Possible values:

• 01 — No preference
• 02 — No challenge requested
• 03 — Challenge requested (3DS Requestor preference)
• 04 — Challenge requested (Mandate)
• 05 — No challenge (transactional risk analysis is already performed)
• 06 — Data Only

Possible values:

• "06"
• "05"
• "04"
• "03"
• "02"
• "01"

Additional information about the Cardholder’s account provided by the 3DS Requestor.

Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Format: YYYYMMDD

Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset. Allowed values:

• 01 — No change
• 02 — Changed during this transaction
• 03 — Less than 30 days
• 04 — 30–60 days
• 05 — More than 60 days

Possible values:

• "05"
• "04"
• "03"
• "02"
• "01"

Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Allowed values:

• 01 — No suspicious activity has been observed
• 02 — Suspicious activity has been observed

Possible values:

• "02"
• "01"

Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters.

Number of purchases with this cardholder account during the previous six months. Max length: 4 characters.

Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Allowed values:

• 01 — Changed during this transaction
• 02 — Less than 30 days
• 03 — 30–60 days
• 04 — More than 60 days

Possible values:

• "04"
• "03"
• "02"
• "01"

Date that cardholder’s account with the 3DS Requestor had a password change or account reset. Format: YYYYMMDD

String when the shipping address used for this transaction was first used with the 3DS Requestor. Format: YYYYMMDD

Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Allowed values:

• 01 — Account Name identical to shipping Name
• 02 — Account Name different to shipping Name

Possible values:

• "02"
• "01"

String that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Format: YYYYMMDD

Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Allowed values:

• 01 — No account (guest checkout)
• 02 — During this transaction
• 03 — Less than 30 days
• 04 — 30–60 days
• 05 — More than 60 days

Possible values:

• "05"
• "04"
• "03"
• "02"
• "01"

Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters.

Length of time that the cardholder has had the account with the 3DS Requestor. Allowed values:

• 01 — No account
• 02 — Created during this transaction
• 03 — Less than 30 days
• 04 — 30–60 days
• 05 — More than 60 days

Possible values:

• "05"
• "04"
• "03"
• "02"
• "01"

Date that the cardholder opened the account with the 3DS Requestor. Format: YYYYMMDD

Number of Add Card attempts in the last 24 hours. Max length: 3 characters.

Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Allowed values:

• 01 — This transaction
• 02 — Less than 30 days
• 03 — 30–60 days
• 04 — More than 60 days

Possible values:

• "04"
• "03"
• "02"
• "01"

Indicates the minimum number of days between authorisations. Maximum length: 4 characters.

The messageVersion value indicating the 3D Secure 2 protocol version.

Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values:

• Y — Shipping Address matches Billing Address.
• N — Shipping Address does not match Billing Address.

Possible values:

• "N"
• "Y"

Required for authentication-only integration. The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.

Optional for a full 3D Secure 2 integration. Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.

Indicates the type of payment for which an authentication is requested (message extension)

Required for authentication-only integration for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.

Required for authentication-only integration. The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.

If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation.

Default value: false

The sdkAppID value as received from the 3D Secure 2 SDK.

Indicates the type of Authentication request.

Identify the type of the transaction being authenticated.

Possible values:

• "accountFunding"
• "checkAcceptance"
• "goodsOrServicePurchase"
• "quasiCashTransaction"
• "prepaidActivationAndLoad"

URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.

Required for authentication-only integration. The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.

Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.

Value true indicates that the transaction was de-tokenised prior to being received by the ACS.

The sdkTransID value as received from the 3D Secure 2 SDK.

The home phone number provided by the Cardholder.

Country code. Length: 1–3 characters.

Subscriber number. Maximum length: 15 characters.

The whiteListStatus value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.

The work phone number provided by the Cardholder.

Country code. Length: 1–3 characters.

Subscriber number. Maximum length: 15 characters.

Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.

This data element provides additional information to the ACS to determine the best approach for handing a request. This data element contains an ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder. Length: 30 characters.

Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM

Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values:

• 01 — Frictionless authentication occurred by ACS.
• 02 — Cardholder challenge occurred by ACS.
• 03 — AVS verified.
• 04 — Other issuer methods.

Possible values:

• "04"
• "03"
• "02"
• "01"

Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.

Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values:

• 01 — Not applicable
• 02 — Credit
• 03 — Debit

Possible values:

• "03"
• "02"
• "01"

Possibility to specify a preference for receiving a challenge from the issuer. Allowed values:

• noPreference
• requestNoChallenge
• requestChallenge
• requestChallengeAsMandate

Possible values:

• "requestChallenge"
• "requestChallengeAsMandate"
• "noPreference"
• "requestNoChallenge"

Display options for the 3D Secure 2 SDK. Optional and only for deviceChannel app.

UI types supported for displaying specific challenges. Allowed values:

• text
• singleSelect
• outOfBand
• otherHtml
• multiSelect

Supported SDK interface types. Allowed values:

• native
• html
• both

Possible values:

• "html"
• "both"
• "native"

Default value: "both"

The mobile phone number provided by the Cardholder.

Country code. Length: 1–3 characters.

Subscriber number. Maximum length: 15 characters.

URL to where the issuer should send the CRes. Required if you are not using components for channel Web or if you are using classic integration deviceChannel browser.

The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for deviceChannel set to app. Defaults to 60 minutes.

Default value: 60

Information about how the 3DS Requestor authenticated the cardholder before or during the transaction

Mechanism used by the Cardholder to authenticate to the 3DS Requestor. Allowed values:

• 01 — No 3DS Requestor authentication occurred (for example, cardholder “logged in” as guest).
• 02 — Login to the cardholder account at the 3DS Requestor system using 3DS Requestor’s own credentials.
• 03 — Login to the cardholder account at the 3DS Requestor system using federated ID.
• 04 — Login to the cardholder account at the 3DS Requestor system using issuer credentials.
• 05 — Login to the cardholder account at the 3DS Requestor system using third-party authentication.
• 06 — Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator.

Possible values:

• "06"
• "05"
• "04"
• "03"
• "02"
• "01"

Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.

Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM

If you want a BIN or card verification request to use a non-zero value, assign this value to additionalAmount (while the amount must be still set to 0 to trigger BIN or card verification). Required to be in the same currency as the amount.

The amount of the transaction, in minor units.

The three-character ISO currency code.

Information about your application. For more details, see Building Adyen solutions.

Merchant developed software, such as cashier application, used to interact with the Adyen API.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.

External platform integrator.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

Merchant device information.

Version of the operating system on the merchant device.

Operating system running on the merchant device.

Merchant device reference.

Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.

Version of the operating system on the shopper interaction device.

Locale on the shopper interaction device.

Operating system running on the shopper interaction device.

Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.

Name of the field. For example, Name of External Platform.

Version of the field. For example, Version of External Platform.

The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.

For 3D Secure 2 transactions, schemes require shopperEmail for all browser-based and mobile implementations.

When you are doing multiple partial (gift card) payments, this is the pspReference of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the merchantOrderReferenceinstead.

The date and time until when the session remains valid, in ISO 8601 format.

For example: 2020-07-18T15:42:40.428+01:00

The details of the bank account, from which the payment should be made.

Either bankAccount or card field must be provided in a payment request.

The Business Identifier Code (BIC) is the SWIFT address assigned to a bank. The field value is nil in most cases.

The location id of the bank. The field value is nil in most cases.

The name of the bank.

The bank city.

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:

• χ12 is converted to ch12.
• üA is converted to euA.
• Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:
• John17 - allowed.
• J17 - allowed.
• 171 - not allowed.
• John-7 - allowed.

If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.

The International Bank Account Number (IBAN).

The bank account holder's tax ID.

The type of the bank account.

Possible values:

• "general"
• "balance"
• "deposit"
• "other"
• "checking"
• "savings"
• "payment"

Country code where the bank is located.

A valid value is an ISO two-character country code (e.g. 'NL').

The bank account number (without separators).

The mandate details to initiate recurring transaction.

The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.

Possible values:

• on: On a specific date.

• before: Before and on a specific date.

• after: On and after a specific date.

Possible values:

• "on"
• "before"
• "after"

The frequency with which a shopper should be charged.

Possible values: adhoc, daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly.

Possible values:

• "biWeekly"
• "monthly"
• "adhoc"
• "weekly"
• "halfYearly"
• "yearly"
• "daily"
• "quarterly"

The number of transactions that can be performed within the given frequency.

Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.

The message shown by UPI to the shopper on the approval screen.

End date of the billing plan, in YYYY-MM-DD format.

The billing amount (in minor units) of the recurring transactions.

The limitation rule of the billing amount.

Possible values:

• max: The transaction amount can not exceed the amount.

• exact: The transaction amount should be the same as the amount.

Possible values:

• "exact"
• "max"

The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.

Possible values: 1-31 based on the frequency.

A unique ID that can be used to associate /paymentMethods and /payments requests with the same shopper transaction, offering insights into conversion rates.

An integer value that is added to the normal fraud score. The value can be either positive or negative.

Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.

The person or entity funding the money.

The email address of the person funding the money.

The name of the person funding the money.

The last name.

The first name.

The address where to send the invoice.

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.

The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

The number or name of the house. Maximum length: 3000 characters.

The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

The name of the city. Maximum length: 3000 characters.

The phone number of the person funding the money.

The unique identifier of the wallet where the funds are coming from.

The type and required details of a payment method to use.

Date after which no further authorisations shall be performed. Only for 3D Secure 2.

The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

For 3D Secure 2 transactions, schemes require shopperIP for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, contact Support.

The shopper's full name.

The last name.

The first name.

Minimum number of days between authorisations. Only for 3D Secure 2.

Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.

The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.

The shopper's telephone number.

When true and shopperReference is provided, the payment details will be stored for future recurring payments.

Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default.

This field has the following possible values:

• Ecommerce - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.
• ContAuth - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).
• Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.
• POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.

Possible values:

• "ContAuth"
• "Ecommerce"
• "POS"
• "Moto"

Information regarding the company.

The company website's home page.

The company name.

Registration number of the company.

Registry location of the company.

The company type.

Tax ID of the company.

The URL to return to in case of a redirection. The format depends on the channel.

• For web, include the protocol http:// or https://. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: https://your-company.com/checkout?shopperOrder=12xy
• For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the Apple Developer documentation. Example: my-app://
• For Android, use a custom URL handled by an Activity on your app. You can configure it with an intent filter. Example: my-app://your.package.name

If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value.

The URL must not include personally identifiable information (PII), for example name or email address.

The shopper's social security number.

Required for Adyen for Platforms integrations if you are a platform model. This is your reference (on balance platform) or the storeReference (in the classic integration) for the ecommerce or point-of-sale store that is processing the payment.

the person or entity receiving the money

The purpose of a digital wallet transaction.

Possible values:

• "transferOwnWallet"
• "transferDifferentWallet"
• "transferSameWallet"
• "unidentifiedBoleto"
• "identifiedBoleto"

The payment method used by the shopper.

The reference for the Click to Pay token.

The encrypted card verification code.

The card verification code. Only collect raw card data if you are fully PCI compliant.

Secondary brand of the card. For example: plastix, hmclub.

The card number. Only collect raw card data if you are fully PCI compliant.

The card expiry month. Only collect raw card data if you are fully PCI compliant.

The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to debit.

Possible values:

• "credit"
• "debit"

An identifier used for the Click to Pay transaction.

The encrypted card expiry year.

The scheme that is being used for Click to Pay.

The encrypted card expiry month.

The transaction identifier from card schemes. This is the networkTxReference from the response to the first payment.

The SRC reference for the Click to Pay token.

Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.

This is the recurringDetailReference returned in the response when you created the token.

The shopperNotificationReference returned in the response when you requested to notify the shopper. Used only for recurring payments in India.

The name of the card holder.

Default payment method details. Common for scheme payment methods, and for simple payment method details.

Possible values:

• "bcmc"
• "giftcard"
• "card"
• "scheme"
• "networkToken"

Default value: "scheme"

This is the recurringDetailReference returned in the response when you created the token.

The encrypted card number.

The checkout attempt identifier.

The card expiry year. Only collect raw card data if you are fully PCI compliant.

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

Your reference must not include personally identifiable information (PII), for example name or email address.

The email address of the shopper.

Required for back-to-back/purchase-driven-load transactions, where the funds are taken from the shopper's stored card when the wallet balance is insufficient. The final merchant who will receive the money, also known as a sub-merchant.

The sub-merchant's 4-digit Merchant Category Code (MCC).

• Format: Numeric
• Fixed length: 4 digits

The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.

• Format: Alphanumeric
• Maximum length: 22 characters

The tax ID of the sub-merchant.

• Format: Numeric
• Fixed length: 11 digits for the CPF or 14 digits for the CNPJ

The three-letter country code of the sub-merchant's address. For example, BRA for Brazil.

• Format: ISO 3166-1 alpha-3
• Fixed length: 3 characters

The city of the sub-merchant's address.

• Format: Alphanumeric
• Maximum length: 13 characters

The name of the shopper.

The last name.

The first name.

The tax identifier of the person receiving the funds.

The IBAN of the bank account where the funds are being transferred to.

The address where to send the invoice.

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.

The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

The number or name of the house. Maximum length: 3000 characters.

The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

The name of the city. Maximum length: 3000 characters.

This is the recurringDetailReference returned in the response when you created the token.

The telephone number of the shopper.

The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier.

When true and shopperReference is provided, the payment details will be stored for recurring payments where the shopper is not present, such as subscription or automatic top-up payments.

Shopper account information for 3D Secure 2.

For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.

Date the selected delivery address was first used.

Indicator when the shopper has changed their password. Allowed values:

• notApplicable
• thisTransaction
• lessThan30Days
• from30To60Days
• moreThan60Days

Possible values:

• "moreThan60Days"
• "notApplicable"
• "thisTransaction"
• "lessThan30Days"
• "from30To60Days"

Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values:

• notApplicable
• thisTransaction
• lessThan30Days
• from30To60Days
• moreThan60Days

Possible values:

• "moreThan60Days"
• "notApplicable"
• "thisTransaction"
• "lessThan30Days"
• "from30To60Days"

Number of attempts the shopper tried to add a card to their account in the last day.

Date when the shopper's account was created.

Number of successful purchases in the last six months.

Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.

Indicator for the length of time since the shopper's account was last updated. Allowed values:

• thisTransaction
• lessThan30Days
• from30To60Days
• moreThan60Days

Possible values:

• "moreThan60Days"
• "thisTransaction"
• "lessThan30Days"
• "from30To60Days"

Shopper's home phone number (including the country code).

Indicator for the length of time since this delivery address was first used. Allowed values:

• thisTransaction
• lessThan30Days
• from30To60Days
• moreThan60Days

Possible values:

• "moreThan60Days"
• "thisTransaction"
• "lessThan30Days"
• "from30To60Days"

Whether suspicious activity was recorded on this account.

Shopper's work phone number (including the country code).

Date when the shopper last changed their password.

Indicator for the length of time since this payment method was added to this shopper's account. Allowed values:

• notApplicable
• thisTransaction
• lessThan30Days
• from30To60Days
• moreThan60Days

Possible values:

• "moreThan60Days"
• "notApplicable"
• "thisTransaction"
• "lessThan30Days"
• "from30To60Days"

Shopper's mobile phone number (including the country code).

Date when the shopper's account was last changed.

Indicates the type of account. For example, for a multi-account card product. Allowed values:

• notApplicable
• credit
• debit

Possible values:

• "credit"
• "notApplicable"
• "debit"

Date this payment method was added to the shopper's account.

Number of all transactions (successful and abandoned) from this shopper in the past year.

Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).

Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.

The electronic commerce indicator.

The CAVV algorithm used. Include this only for 3D Secure 1.

In 3D Secure 1, the authentication response if the shopper was redirected.

In 3D Secure 2, this is the transStatus from the challenge result. If the transaction was frictionless, omit this parameter.

Possible values:

• "A"
• "N"
• "Y"
• "U"

In 3D Secure 1, this is the enrollment response from the 3D directory server.

In 3D Secure 2, this is the transStatus from the ARes.

Possible values:

• "D"
• "C"
• "R"
• "A"
• "N"
• "I"
• "Y"
• "U"

The version of the 3D Secure protocol.

Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to 3D Secure API reference.

Possible values:

• "07"
• "06"
• "05"
• "04"
• "03"
• "02"
• "01"

Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

Network token authentication verification value (TAVV). The network token cryptogram.

Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).

Provides information on why the transStatus field has the specified value. For possible values, refer to our docs.

The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).

The address where to send the invoice.

The billingAddress object is required in the following scenarios. Include all of the fields within this object.

• For 3D Secure 2 transactions in all browser-based and mobile implementations.
• For cross-border payouts to and from Canada.

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.

The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

The number or name of the house. Maximum length: 3000 characters.

The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

The name of the city. Maximum length: 3000 characters.

The shopper country.

Format: ISO 3166-1 alpha-2 Example: NL or DE

The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the sdkVersion or token.

Possible values:

• iOS
• Android
• Web

Possible values:

• "iOS"
• "Web"
• "Android"

The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).

The amount of the transaction, in minor units.

The three-character ISO currency code.

This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator

Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant.

• Format: Alphanumeric
• Maximum length: 15 characters

Required for transactions performed by registered payment facilitators. The email associated with the sub-merchant's account.

Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).

• Format: Numeric
• Fixed length: 4 digits

Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.

• Format: Alphanumeric
• Maximum length: 22 characters

Required for transactions performed by registered payment facilitators. The sub-merchant's URL on the platform, i.e. the sub-merchant's shop.

Required for transactions performed by registered payment facilitators. The amount of the payment corresponding to each sub-merchant. This value will be different than the request amount if shopper is purchasing items at different sub-merchants' shops.

The amount of the transaction, in minor units.

The three-character ISO currency code.

Required for transactions performed by registered payment facilitators. The phone number associated with the sub-merchant's account.

Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.

• Format: Numeric
• Fixed length: 11 digits for the CPF or 14 digits for the CNPJ

Required for transactions performed by registered payment facilitators. The sub-merchant's address.

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.

The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

The number or name of the house. Maximum length: 3000 characters.

The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

The name of the city. Maximum length: 3000 characters.

Required for the 3D Secure 2 channel Web integration.

Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.

The reason for the amount update. Possible values:

• delayedCharge
• noShow
• installment

Possible values:

• "noShow"
• "delayedCharge"
• "installment"

Contains risk data, such as client-side data, used to identify risk for a transaction.

Any custom fields used as part of the input to configured risk rules.

The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.

Contains client-side data, like the device fingerprint, cookies, and specific browser settings.

An integer value that is added to the normal fraud score. The value can be either positive or negative.

The shopper's date of birth.

Format ISO-8601: YYYY-MM-DD

The localizedShopperStatement field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, shopperStatement is used.

Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:

• UTF-8 based Katakana, capital letters, numbers and special characters.
• Half-width or full-width characters.