POST /paymentMethods/balance

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.

The collection that contains the type of the payment method and its specific information.

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.

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.

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.

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 . , ' _ - ? + * /.

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 recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.

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

The shopper's telephone number.

The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).

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 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"

An array of objects specifying how the payment should be split when using either Adyen for Platforms for marketplaces or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone 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.

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:

• maestro (default), to be processed like a Maestro card, or
• bcmc, to be processed like a Bancontact card.

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.

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.

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 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 recurring settings for the payment. Use this property when you want to enable recurring payments.

The type of recurring contract to be used. Possible values:

• ONECLICK – Payment details can be used to initiate a one-click payment, where the shopper enters the card security code (CVC/CVV).
• RECURRING – Payment details can be used without the card security code to initiate card-not-present transactions.
• ONECLICK,RECURRING – Payment details can be used regardless of whether the shopper is on your site or not.
• PAYOUT – Payment details can be used to make a payout.

Possible values:

• "ONECLICK"
• "PAYOUT"
• "RECURRING"

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

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

The name of the token service.

Possible values:

• "MCTOKENSERVICE"
• "AMEXTOKENSERVICE"
• "VISATOKENSERVICE"
• "TOKEN_SHARING"

A descriptive name for this detail.

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. Required for deviceChannel set to app.

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. Only for deviceChannel set to app.

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"

The sdkEncData value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.

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 environment of the shopper. Allowed values:

• app
• browser

The sdkAppID value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.

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. Only for deviceChannel set to app.

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"

Version of the 3D Secure 2 mobile SDK. Only for deviceChannel set to app.

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

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.

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.

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 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.

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

A session ID used to identify a payment session.

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.