{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-balance-check-request-schema.json", "title": "BalanceCheckRequest", "x-generated": "2026-10-12", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/adyen-balance-api-openapi.yml#/components/schemas/BalanceCheckRequest", "properties": { "accountInfo": { "x-addedInVersion": "40", "description": "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref": "#/$defs/AccountInfo" }, "additionalAmount": { "description": "If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-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).\nRequired to be in the same currency as the `amount`. ", "$ref": "#/$defs/Amount" }, "additionalData": { "additionalProperties": { "type": "string" }, "x-anyOf": [ { "$ref": "#/$defs/AdditionalData3DSecure" }, { "$ref": "#/$defs/AdditionalDataAirline" }, { "$ref": "#/$defs/AdditionalDataCarRental" }, { "$ref": "#/$defs/AdditionalDataCommon" }, { "$ref": "#/$defs/AdditionalDataLevel23" }, { "$ref": "#/$defs/AdditionalDataLodging" }, { "$ref": "#/$defs/AdditionalDataOpenInvoice" }, { "$ref": "#/$defs/AdditionalDataOpi" }, { "$ref": "#/$defs/AdditionalDataRatepay" }, { "$ref": "#/$defs/AdditionalDataRetry" }, { "$ref": "#/$defs/AdditionalDataRisk" }, { "$ref": "#/$defs/AdditionalDataRiskStandalone" }, { "$ref": "#/$defs/AdditionalDataSubMerchant" }, { "$ref": "#/$defs/AdditionalDataTemporaryServices" }, { "$ref": "#/$defs/AdditionalDataWallets" } ], "description": "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.", "type": "object" }, "amount": { "description": "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).", "$ref": "#/$defs/Amount" }, "applicationInfo": { "x-addedInVersion": "40", "description": "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref": "#/$defs/ApplicationInfo" }, "billingAddress": { "x-addedInVersion": "4", "description": "The address where to send the invoice.\n> The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.\n>* For 3D Secure 2 transactions in all browser-based and mobile implementations.\n>* For cross-border payouts to and from Canada.", "$ref": "#/$defs/Address" }, "browserInfo": { "description": "The shopper's browser information.\n> 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.", "$ref": "#/$defs/BrowserInfo" }, "captureDelayHours": { "x-addedInVersion": "2", "description": "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format": "int32", "type": "integer" }, "dateOfBirth": { "x-addedInVersion": "7", "description": "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", "format": "date", "type": "string" }, "dccQuote": { "description": "The forex quote as returned in the response of the forex service.", "$ref": "#/$defs/ForexQuote" }, "deliveryAddress": { "description": "The address where the purchased goods should be delivered.", "$ref": "#/$defs/Address" }, "deliveryDate": { "x-addedInVersion": "8", "description": "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format": "date-time", "type": "string" }, "deviceFingerprint": { "x-addedInVersion": "2", "description": "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength": 5000, "type": "string" }, "fraudOffset": { "description": "An integer value that is added to the normal fraud score. The value can be either positive or negative.", "format": "int32", "type": "integer" }, "installments": { "x-addedInVersion": "4", "description": "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref": "#/$defs/Installments" }, "localizedShopperStatement": { "x-addedInVersion": "68", "additionalProperties": { "type": "string" }, "description": "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters.", "type": "object" }, "mcc": { "x-addedInVersion": "12", "description": "The [merchant category code](https://en.wikipedia.org/wiki/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.", "type": "string" }, "merchantAccount": { "description": "The merchant account identifier, with which you want to process the transaction.", "type": "string" }, "merchantOrderReference": { "x-addedInVersion": "9", "description": "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.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> 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`.", "type": "string" }, "merchantRiskIndicator": { "x-addedInVersion": "40", "description": "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref": "#/$defs/MerchantRiskIndicator" }, "metadata": { "x-addedInVersion": "17", "additionalProperties": { "type": "string" }, "description": "Metadata consists of entries, each of which includes a key and a value.\nLimits:\n* Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\".\n* Maximum 20 characters per key.\n* Maximum 80 characters per value. ", "type": "object" }, "orderReference": { "description": "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 `merchantOrderReference`instead.", "type": "string" }, "paymentMethod": { "additionalProperties": { "type": "string" }, "description": "The collection that contains the type of the payment method and its specific information.", "type": "object" }, "recurring": { "description": "The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).", "$ref": "#/$defs/Recurring" }, "recurringProcessingModel": { "x-addedInVersion": "30", "description": "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `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.\n* `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.\n", "enum": [ "CardOnFile", "Subscription", "UnscheduledCardOnFile" ], "type": "string" }, "reference": { "description": "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.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type": "string" }, "selectedBrand": { "description": "Some payment methods require defining a value for this field to specify how to process the transaction.\n\nFor the Bancontact payment method, it can be set to:\n* `maestro` (default), to be processed like a Maestro card, or\n* `bcmc`, to be processed like a Bancontact card.", "type": "string" }, "selectedRecurringDetailReference": { "description": "The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.", "type": "string" }, "sessionId": { "description": "A session ID used to identify a payment session.", "type": "string" }, "shopperEmail": { "description": "The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.", "type": "string" }, "shopperIP": { "description": "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).\n> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.\nThis field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).", "type": "string" }, "shopperInteraction": { "description": "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `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.\n* `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).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.", "enum": [ "Ecommerce", "ContAuth", "Moto", "POS" ], "type": "string" }, "shopperLocale": { "x-addedInVersion": "7", "description": "The combination of a language code and a country code to specify the language to be used in the payment.", "type": "string" }, "shopperName": { "x-addedInVersion": "7", "description": "The shopper's full name.", "$ref": "#/$defs/Name" }, "shopperReference": { "description": "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.", "type": "string" }, "shopperStatement": { "description": "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.", "type": "string" }, "socialSecurityNumber": { "x-addedInVersion": "4", "description": "The shopper's social security number.", "type": "string" }, "splits": { "x-addedInVersion": "37", "description": "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items": { "$ref": "#/$defs/Split" }, "type": "array" }, "store": { "x-addedInVersion": "23", "description": "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength": 16, "minLength": 1, "type": "string" }, "telephoneNumber": { "x-addedInVersion": "7", "description": "The shopper's telephone number.", "type": "string" }, "threeDS2RequestData": { "x-addedInVersion": "40", "description": "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref": "#/$defs/ThreeDS2RequestData" }, "threeDSAuthenticationOnly": { "x-addedInVersion": "50", "deprecated": true, "x-deprecatedInVersion": "69", "x-deprecatedMessage": "Use `authenticationData.authenticationOnly` instead.", "default": false, "description": "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", "type": "boolean" }, "totalsGroup": { "x-addedInVersion": "23", "description": "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength": 16, "minLength": 1, "type": "string" }, "trustedShopper": { "x-addedInVersion": "37", "description": "Set to true if the payment should be routed to a trusted MID.", "type": "boolean" } }, "required": [ "merchantAccount", "amount", "paymentMethod" ], "type": "object", "$defs": { "AccountInfo": { "properties": { "accountAgeIndicator": { "description": "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", "enum": [ "notApplicable", "thisTransaction", "lessThan30Days", "from30To60Days", "moreThan60Days" ], "type": "string" }, "accountChangeDate": { "description": "Date when the shopper's account was last changed.", "format": "date-time", "type": "string" }, "accountChangeIndicator": { "description": "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", "enum": [ "thisTransaction", "lessThan30Days", "from30To60Days", "moreThan60Days" ], "type": "string" }, "accountCreationDate": { "description": "Date when the shopper's account was created.", "format": "date-time", "type": "string" }, "accountType": { "x-addedInVersion": "50", "description": "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum": [ "notApplicable", "credit", "debit" ], "type": "string" }, "addCardAttemptsDay": { "description": "Number of attempts the shopper tried to add a card to their account in the last day.", "format": "int32", "type": "integer" }, "deliveryAddressUsageDate": { "description": "Date the selected delivery address was first used.", "format": "date-time", "type": "string" }, "deliveryAddressUsageIndicator": { "description": "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", "enum": [ "thisTransaction", "lessThan30Days", "from30To60Days", "moreThan60Days" ], "type": "string" }, "homePhone": { "deprecated": true, "x-deprecatedInVersion": "68", "x-deprecatedMessage": "Use `ThreeDS2RequestData.homePhone` instead.", "description": "Shopper's home phone number (including the country code).", "type": "string" }, "mobilePhone": { "deprecated": true, "x-deprecatedInVersion": "68", "x-deprecatedMessage": "Use `ThreeDS2RequestData.mobilePhone` instead.", "description": "Shopper's mobile phone number (including the country code).", "type": "string" }, "passwordChangeDate": { "description": "Date when the shopper last changed their password.", "format": "date-time", "type": "string" }, "passwordChangeIndicator": { "description": "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", "enum": [ "notApplicable", "thisTransaction", "lessThan30Days", "from30To60Days", "moreThan60Days" ], "type": "string" }, "pastTransactionsDay": { "description": "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", "format": "int32", "type": "integer" }, "pastTransactionsYear": { "description": "Number of all transactions (successful and abandoned) from this shopper in the past year.", "format": "int32", "type": "integer" }, "paymentAccountAge": { "description": "Date this payment method was added to the shopper's account.", "format": "date-time", "type": "string" }, "paymentAccountIndicator": { "description": "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", "enum": [ "notApplicable", "thisTransaction", "lessThan30Days", "from30To60Days", "moreThan60Days" ], "type": "string" }, "purchasesLast6Months": { "description": "Number of successful purchases in the last six months.", "format": "int32", "type": "integer" }, "suspiciousActivity": { "description": "Whether suspicious activity was recorded on this account.", "type": "boolean" }, "workPhone": { "deprecated": true, "x-deprecatedInVersion": "68", "x-deprecatedMessage": "Use `ThreeDS2RequestData.workPhone` instead.", "description": "Shopper's work phone number (including the country code).", "type": "string" } }, "type": "object" }, "AcctInfo": { "properties": { "chAccAgeInd": { "description": "Length of time that the cardholder has had the account with the 3DS Requestor. \nAllowed values:\n* **01** No account\n* **02** Created during this transaction\n* **03** Less than 30 days\n* **04** 3060 days\n* **05** More than 60 days", "enum": [ "01", "02", "03", "04", "05" ], "maxLength": 2, "minLength": 2, "type": "string" }, "chAccChange": { "description": "Date that the cardholders account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nFormat: **YYYYMMDD**", "type": "string" }, "chAccChangeInd": { "description": "Length of time since the cardholders account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nAllowed values:\n* **01** Changed during this transaction\n* **02** Less than 30 days\n* **03** 3060 days\n* **04** More than 60 days", "enum": [ "01", "02", "03", "04" ], "maxLength": 2, "minLength": 2, "type": "string" }, "chAccPwChange": { "description": "Date that cardholders account with the 3DS Requestor had a password change or account reset. \nFormat: **YYYYMMDD**", "type": "string" }, "chAccPwChangeInd": { "description": "Indicates the length of time since the cardholders account with the 3DS Requestor had a password change or account reset. \nAllowed values:\n* **01** No change\n* **02** Changed during this transaction\n* **03** Less than 30 days\n* **04** 3060 days\n* **05** More than 60 days", "enum": [ "01", "02", "03", "04", "05" ], "maxLength": 2, "minLength": 2, "type": "string" }, "chAccString": { "description": "Date that the cardholder opened the account with the 3DS Requestor. \nFormat: **YYYYMMDD**", "type": "string" }, "nbPurchaseAccount": { "description": "Number of purchases with this cardholder account during the previous six months. Max length: 4 characters.", "type": "string" }, "paymentAccAge": { "description": "String that the payment account was enrolled in the cardholders account with the 3DS Requestor. \nFormat: **YYYYMMDD**", "type": "string" }, "paymentAccInd": { "description": "Indicates the length of time that the payment account was enrolled in the cardholders account with the 3DS Requestor. \nAllowed values:\n* **01** No account (guest checkout)\n* **02** During this transaction\n* **03** Less than 30 days\n* **04** 3060 days\n* **05** More than 60 days", "enum": [ "01", "02", "03", "04", "05" ], "maxLength": 2, "minLength": 2, "type": "string" }, "provisionAttemptsDay": { "description": "Number of Add Card attempts in the last 24 hours. Max length: 3 characters.", "type": "string" }, "shipAddressUsage": { "description": "String when the shipping address used for this transaction was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**", "type": "string" }, "shipAddressUsageInd": { "description": "Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. \nAllowed values:\n* **01** This transaction\n* **02** Less than 30 days\n* **03** 3060 days\n* **04** More than 60 days", "enum": [ "01", "02", "03", "04" ], "maxLength": 2, "minLength": 2, "type": "string" }, "shipNameIndicator": { "description": "Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. \nAllowed values:\n* **01** Account Name identical to shipping Name\n* **02** Account Name different to shipping Name", "enum": [ "01", "02" ], "maxLength": 2, "minLength": 2, "type": "string" }, "suspiciousAccActivity": { "description": "Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. \nAllowed values:\n* **01** No suspicious activity has been observed\n* **02** Suspicious activity has been observed", "enum": [ "01", "02" ], "maxLength": 2, "minLength": 2, "type": "string" }, "txnActivityDay": { "description": "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.", "maxLength": 3, "type": "string" }, "txnActivityYear": { "description": "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.", "maxLength": 3, "type": "string" } }, "type": "object" }, "AdditionalData3DSecure": { "properties": { "allow3DS2": { "deprecated": true, "x-deprecatedInVersion": "69", "x-deprecatedMessage": "Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.", "description": "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\nor send the `executeThreeD` parameter.\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", "type": "string" }, "challengeWindowSize": { "description": "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen", "enum": [ "01", "02", "03", "04", "05" ], "type": "string" }, "executeThreeD": { "deprecated": true, "x-deprecatedInVersion": "69", "x-deprecatedMessage": "Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead", "description": "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** Perform 3D Secure authentication.\n* **false** Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", "type": "string" }, "mpiImplementationType": { "description": "In case of Secure+, this field must be set to **CUPSecurePlus**.", "type": "string" }, "scaExemption": { "description": "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type": "string" }, "threeDSVersion": { "description": "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type": "string" } }, "type": "object" }, "AdditionalDataAirline": { "properties": { "airline.agency_invoice_number": { "description": "The reference number for the invoice, issued by the agency.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 6 characters", "type": "string" }, "airline.agency_plan_name": { "description": "The two-letter agency plan identifier.\n* Encoding: ASCII\n* minLength: 2 characters\n* maxLength: 2 characters", "type": "string" }, "airline.airline_code": { "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.airline_designator_code": { "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.boarding_fee": { "description": "The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1 character\n* maxLength: 18 characters", "type": "string" }, "airline.computerized_reservation_system": { "description": "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Encoding: ASCII\n* minLength: 4 characters\n* maxLength: 4 characters", "type": "string" }, "airline.customer_reference_number": { "description": "The alphanumeric customer reference number.\n* Encoding: ASCII\n* maxLength: 20 characters\n* If you send more than 20 characters, the customer reference number is truncated\n* Must not be all spaces", "type": "string" }, "airline.document_type": { "description": "A code that identifies the type of item bought. The description of the code can appear on credit card statements.\n* Encoding: ASCII\n* Example: Passenger ticket = 01\n* minLength: 2 characters\n* maxLength: 2 characters", "type": "string" }, "airline.flight_date": { "description": "The flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10 characters\n* maxLength: 16 characters", "type": "string" }, "airline.leg.carrier_code": { "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.leg.class_of_travel": { "description": "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.leg.date_of_travel": { "description": "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd HH:mm`.\n* Encoding: ASCII\n* minLength: 16 characters\n* maxLength: 16 characters", "type": "string" }, "airline.leg.depart_airport": { "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.leg.depart_tax": { "description": "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type": "string" }, "airline.leg.destination_code": { "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.leg.fare_base_code": { "description": "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.leg.flight_number": { "description": "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.leg.stop_over_code": { "description": "A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character", "type": "string" }, "airline.passenger.date_of_birth": { "description": "The passenger's date of birth.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", "type": "string" }, "airline.passenger.first_name": { "description": "The passenger's first name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII", "type": "string" }, "airline.passenger.last_name": { "description": "The passenger's last name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII", "type": "string" }, "airline.passenger.telephone_number": { "description": "The passenger's telephone number, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 30 characters", "type": "string" }, "airline.passenger.traveller_type": { "description": "The IATA passenger type code (PTC).\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 6 characters", "type": "string" }, "airline.passenger_name": { "description": "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type": "string" }, "airline.ticket_issue_address": { "description": "The address of the organization that issued the ticket.\n* minLength: 0 characters\n* maxLength: 16 characters", "type": "string" }, "airline.ticket_number": { "description": "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.travel_agency_code": { "description": "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "airline.travel_agency_name": { "description": "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" } }, "required": [ "airline.passenger_name" ], "type": "object" }, "AdditionalDataCarRental": { "properties": { "carRental.checkOutDate": { "description": "The pick-up date.\n* Date format: `yyyyMMdd`", "type": "string" }, "carRental.customerServiceTollFreeNumber": { "description": "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type": "string" }, "carRental.daysRented": { "description": "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type": "string" }, "carRental.fuelCharges": { "description": "Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12", "type": "string" }, "carRental.insuranceCharges": { "description": "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.locationCity": { "description": "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.locationCountry": { "description": "The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n* Format: Alphanumeric\n* maxLength: 2", "type": "string" }, "carRental.locationStateProvince": { "description": "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.noShowIndicator": { "description": "Indicates if the customer didn't pick up their rental car.\n* Y - Customer did not pick up their car\n* N - Not applicable", "type": "string" }, "carRental.oneWayDropOffCharges": { "description": "The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* maxLength: 12", "type": "string" }, "carRental.rate": { "description": "The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Alphanumeric\n* maxLength: 12", "type": "string" }, "carRental.rateIndicator": { "description": "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate\n* W - Weekly rate", "type": "string" }, "carRental.rentalAgreementNumber": { "description": "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.rentalClassId": { "description": "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.renterName": { "description": "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.returnCity": { "description": "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.returnCountry": { "description": "The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n* Format: Alphanumeric\n* maxLength: 2", "type": "string" }, "carRental.returnDate": { "description": "The last date to return the car by.\n* Date format: `yyyyMMdd`\n* maxLength: 8", "type": "string" }, "carRental.returnLocationId": { "description": "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.returnStateProvince": { "description": "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type": "string" }, "carRental.taxExemptIndicator": { "description": "Indicates if the goods or services were tax-exempt, or if tax was not paid on them.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", "type": "string" }, "travelEntertainmentAuthData.duration": { "description": "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type": "string" }, "travelEntertainmentAuthData.market": { "description": "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.\n* Format: Alphanumeric\n* maxLength: 1", "type": "string" } }, "type": "object" }, "AdditionalDataCommon": { "properties": { "RequestedTestErrorResponseCode": { "description": "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type": "string" }, "allowPartialAuth": { "description": "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", "type": "string" }, "authorisationType": { "description": "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** flags the payment request to be handled as a final authorisation.", "type": "string" }, "customRoutingFlag": { "description": "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf 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.\n\nTo enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).", "type": "string" }, "industryUsage": { "description": "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum": [ "NoShow", "DelayedCharge" ], "type": "string" }, "manualCapture": { "description": "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", "type": "string" }, "networkTxReference": { "description": "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.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type": "string" }, "overwriteBrand": { "description": "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", "type": "string" }, "subMerchantCity": { "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", "type": "string" }, "subMerchantCountry": { "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", "type": "string" }, "subMerchantID": { "description": "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", "type": "string" }, "subMerchantName": { "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", "type": "string" }, "subMerchantPostalCode": { "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", "type": "string" }, "subMerchantState": { "description": "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", "type": "string" }, "subMerchantStreet": { "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", "type": "string" }, "subMerchantTaxId": { "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type": "string" } }, "type": "object" }, "AdditionalDataLevel23": { "properties": { "enhancedSchemeData.customerReference": { "description": "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.destinationCountryCode": { "description": "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type": "string" }, "enhancedSchemeData.destinationPostalCode": { "description": "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type": "string" }, "enhancedSchemeData.destinationStateProvinceCode": { "description": "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type": "string" }, "enhancedSchemeData.dutyAmount": { "description": "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type": "string" }, "enhancedSchemeData.freightAmount": { "description": "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode": { "description": "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description": { "description": "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount": { "description": "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode": { "description": "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity": { "description": "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount": { "description": "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure": { "description": "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice": { "description": "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.orderDate": { "description": "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type": "string" }, "enhancedSchemeData.shipFromPostalCode": { "description": "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type": "string" }, "enhancedSchemeData.totalTaxAmount": { "description": "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type": "string" } }, "type": "object" }, "AdditionalDataLodging": { "properties": { "lodging.checkInDate": { "description": "The arrival date.\n* Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.", "type": "string" }, "lodging.checkOutDate": { "description": "The departure date.\n* Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.", "type": "string" }, "lodging.customerServiceTollFreeNumber": { "description": "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type": "string" }, "lodging.fireSafetyActIndicator": { "description": "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be 'Y' or 'N'.\n* Format: alphabetic\n* Max length: 1 character", "type": "string" }, "lodging.folioCashAdvances": { "description": "The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters", "type": "string" }, "lodging.folioNumber": { "description": "The card acceptors internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type": "string" }, "lodging.foodBeverageCharges": { "description": "Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters", "type": "string" }, "lodging.noShowIndicator": { "description": "Indicates if the customer didn't check in for their booking.\n Possible values: \n* **Y**: the customer didn't check in \n* **N**: the customer checked in", "type": "string" }, "lodging.prepaidExpenses": { "description": "The prepaid expenses for the booking.\n* Format: numeric\n* Max length: 12 characters", "type": "string" }, "lodging.propertyPhoneNumber": { "description": "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type": "string" }, "lodging.room1.numberOfNights": { "description": "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type": "string" }, "lodging.room1.rate": { "description": "The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters\n* Must not be a negative number", "type": "string" }, "lodging.totalRoomTax": { "description": "The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters\n* Must not be a negative number", "type": "string" }, "lodging.totalTax": { "description": "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters\n* Must not be a negative number", "type": "string" }, "travelEntertainmentAuthData.duration": { "description": "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type": "string" }, "travelEntertainmentAuthData.market": { "description": "Indicates what market-specific dataset will be submitted. Must be 'H' for Hotel. This should be included in the auth message.\n\n* Format: alphanumeric\n* Max length: 1 character", "type": "string" } }, "type": "object" }, "AdditionalDataOpenInvoice": { "properties": { "openinvoicedata.merchantData": { "description": "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", "type": "string" }, "openinvoicedata.numberOfLines": { "description": "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", "type": "string" }, "openinvoicedata.recipientFirstName": { "description": "First name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna.", "type": "string" }, "openinvoicedata.recipientLastName": { "description": "Last name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna.", "type": "string" }, "openinvoicedataLine[itemNr].currencyCode": { "description": "The three-character ISO currency code.", "type": "string" }, "openinvoicedataLine[itemNr].description": { "description": "A text description of the product the invoice line refers to.", "type": "string" }, "openinvoicedataLine[itemNr].itemAmount": { "description": "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", "type": "string" }, "openinvoicedataLine[itemNr].itemId": { "description": "A unique id for this item. Required for RatePay if the description of each item is not unique.", "type": "string" }, "openinvoicedataLine[itemNr].itemVatAmount": { "description": "The VAT due for one item in the invoice line, represented in minor units.", "type": "string" }, "openinvoicedataLine[itemNr].itemVatPercentage": { "description": "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", "type": "string" }, "openinvoicedataLine[itemNr].numberOfItems": { "description": "The number of units purchased of a specific product.", "type": "string" }, "openinvoicedataLine[itemNr].returnShippingCompany": { "description": "Name of the shipping company handling the the return shipment.", "type": "string" }, "openinvoicedataLine[itemNr].returnTrackingNumber": { "description": "The tracking number for the return of the shipment.", "type": "string" }, "openinvoicedataLine[itemNr].returnTrackingUri": { "description": "URI where the customer can track the return of their shipment.", "type": "string" }, "openinvoicedataLine[itemNr].shippingCompany": { "description": "Name of the shipping company handling the delivery.", "type": "string" }, "openinvoicedataLine[itemNr].shippingMethod": { "description": "Shipping method.", "type": "string" }, "openinvoicedataLine[itemNr].trackingNumber": { "description": "The tracking number for the shipment.", "type": "string" }, "openinvoicedataLine[itemNr].trackingUri": { "description": "URI where the customer can track their shipment.", "type": "string" } }, "type": "object" }, "AdditionalDataOpi": { "properties": { "opi.includeTransToken": { "description": "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type": "string" } }, "type": "object" }, "AdditionalDataRatepay": { "properties": { "ratepay.installmentAmount": { "description": "Amount the customer has to pay each month.", "type": "string" }, "ratepay.interestRate": { "description": "Interest rate of this installment.", "type": "string" }, "ratepay.lastInstallmentAmount": { "description": "Amount of the last installment.", "type": "string" }, "ratepay.paymentFirstday": { "description": "Calendar day of the first payment.", "type": "string" }, "ratepaydata.deliveryDate": { "description": "Date the merchant delivered the goods to the customer.", "type": "string" }, "ratepaydata.dueDate": { "description": "Date by which the customer must settle the payment.", "type": "string" }, "ratepaydata.invoiceDate": { "description": "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", "type": "string" }, "ratepaydata.invoiceId": { "description": "Identification name or number for the invoice, defined by the merchant.", "type": "string" } }, "type": "object" }, "AdditionalDataRetry": { "properties": { "retry.chainAttemptNumber": { "description": "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type": "string" }, "retry.orderAttemptNumber": { "description": "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type": "string" }, "retry.skipRetry": { "description": "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type": "string" } }, "type": "object" }, "AdditionalDataRisk": { "properties": { "riskdata.[customFieldName]": { "description": "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", "type": "string" }, "riskdata.basket.item[itemNr].amountPerItem": { "description": "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", "type": "string" }, "riskdata.basket.item[itemNr].brand": { "description": "Brand of the item.", "type": "string" }, "riskdata.basket.item[itemNr].category": { "description": "Category of the item.", "type": "string" }, "riskdata.basket.item[itemNr].color": { "description": "Color of the item.", "type": "string" }, "riskdata.basket.item[itemNr].currency": { "description": "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", "type": "string" }, "riskdata.basket.item[itemNr].itemID": { "description": "ID of the item.", "type": "string" }, "riskdata.basket.item[itemNr].manufacturer": { "description": "Manufacturer of the item.", "type": "string" }, "riskdata.basket.item[itemNr].productTitle": { "description": "A text description of the product the invoice line refers to.", "type": "string" }, "riskdata.basket.item[itemNr].quantity": { "description": "Quantity of the item purchased.", "type": "string" }, "riskdata.basket.item[itemNr].receiverEmail": { "description": "Email associated with the given product in the basket (usually in electronic gift cards).", "type": "string" }, "riskdata.basket.item[itemNr].size": { "description": "Size of the item.", "type": "string" }, "riskdata.basket.item[itemNr].sku": { "description": "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", "type": "string" }, "riskdata.basket.item[itemNr].upc": { "description": "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", "type": "string" }, "riskdata.promotions.promotion[itemNr].promotionCode": { "description": "Code of the promotion.", "type": "string" }, "riskdata.promotions.promotion[itemNr].promotionDiscountAmount": { "description": "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", "type": "string" }, "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency": { "description": "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", "type": "string" }, "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage": { "description": "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", "type": "string" }, "riskdata.promotions.promotion[itemNr].promotionName": { "description": "Name of the promotion.", "type": "string" }, "riskdata.riskProfileReference": { "description": "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", "type": "string" }, "riskdata.skipRisk": { "description": "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type": "string" } }, "type": "object" }, "AdditionalDataRiskStandalone": { "properties": { "PayPal.CountryCode": { "description": "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", "type": "string" }, "PayPal.EmailId": { "description": "Shopper's email.", "type": "string" }, "PayPal.FirstName": { "description": "Shopper's first name.", "type": "string" }, "PayPal.LastName": { "description": "Shopper's last name.", "type": "string" }, "PayPal.PayerId": { "description": "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", "type": "string" }, "PayPal.Phone": { "description": "Shopper's phone number.", "type": "string" }, "PayPal.ProtectionEligibility": { "description": "Allowed values:\n* **Eligible** Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** Merchant is not protected under the Seller Protection Policy.", "type": "string" }, "PayPal.TransactionId": { "description": "Unique transaction ID of the payment.", "type": "string" }, "avsResultRaw": { "description": "Raw AVS result received from the acquirer, where available. Example: D", "type": "string" }, "bin": { "description": "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", "type": "string" }, "cvcResultRaw": { "description": "Raw CVC result received from the acquirer, where available. Example: 1", "type": "string" }, "riskToken": { "description": "Unique identifier or token for the shopper's card details.", "type": "string" }, "threeDAuthenticated": { "description": "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", "type": "string" }, "threeDOffered": { "description": "A Boolean value indicating whether 3DS was offered for this payment. Example: true", "type": "string" }, "tokenDataType": { "description": "Required for PayPal payments only. The only supported value is: **paypal**.", "type": "string" } }, "type": "object" }, "AdditionalDataSubMerchant": { "properties": { "subMerchant.numberOfSubSellers": { "description": "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", "type": "string" }, "subMerchant.subSeller[subSellerNr].city": { "description": "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", "type": "string" }, "subMerchant.subSeller[subSellerNr].country": { "description": "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type": "string" }, "subMerchant.subSeller[subSellerNr].id": { "description": "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. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type": "string" }, "subMerchant.subSeller[subSellerNr].mcc": { "description": "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", "type": "string" }, "subMerchant.subSeller[subSellerNr].name": { "description": "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.\n* Format: Alphanumeric\n* Maximum length: 22 characters", "type": "string" }, "subMerchant.subSeller[subSellerNr].postalCode": { "description": "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", "type": "string" }, "subMerchant.subSeller[subSellerNr].state": { "description": "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", "type": "string" }, "subMerchant.subSeller[subSellerNr].street": { "description": "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", "type": "string" }, "subMerchant.subSeller[subSellerNr].taxId": { "description": "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type": "string" } }, "type": "object" }, "AdditionalDataTemporaryServices": { "properties": { "enhancedSchemeData.customerReference": { "description": "The customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", "type": "string" }, "enhancedSchemeData.employeeName": { "description": "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type": "string" }, "enhancedSchemeData.jobDescription": { "description": "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type": "string" }, "enhancedSchemeData.regularHoursRate": { "description": "The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* maxLength: 7\n* Must not be empty\n* Can be all zeros", "type": "string" }, "enhancedSchemeData.regularHoursWorked": { "description": "The hours worked.\n* maxLength: 7\n* Must not be empty\n* Can be all zeros", "type": "string" }, "enhancedSchemeData.requestName": { "description": "The name of the person requesting temporary services.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", "type": "string" }, "enhancedSchemeData.tempStartDate": { "description": "The billing period start date.\n* Format: ddMMyy\n* maxLength: 6", "type": "string" }, "enhancedSchemeData.tempWeekEnding": { "description": "The billing period end date.\n* Format: ddMMyy\n* maxLength: 6", "type": "string" }, "enhancedSchemeData.totalTaxAmount": { "description": "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). For example, 2000 means USD 20.00\n* maxLength: 12", "type": "string" } }, "type": "object" }, "AdditionalDataWallets": { "properties": { "androidpay.token": { "description": "The Android Pay token retrieved from the SDK.", "type": "string" }, "masterpass.transactionId": { "description": "The Mastercard Masterpass Transaction ID retrieved from the SDK.", "type": "string" }, "payment.token": { "description": "The Apple Pay token retrieved from the SDK.", "type": "string" }, "paywithgoogle.token": { "description": "The Google Pay token retrieved from the SDK.", "type": "string" }, "samsungpay.token": { "description": "The Samsung Pay token retrieved from the SDK.", "type": "string" }, "visacheckout.callId": { "description": "The Visa Checkout Call ID retrieved from the SDK.", "type": "string" } }, "type": "object" }, "Address": { "properties": { "city": { "description": "The name of the city. Maximum length: 3000 characters.", "maxLength": 3000, "type": "string" }, "country": { "description": "The two-character ISO-3166-1 alpha-2 country code. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.", "type": "string" }, "houseNumberOrName": { "description": "The number or name of the house. Maximum length: 3000 characters.", "maxLength": 3000, "type": "string" }, "postalCode": { "description": "A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.", "type": "string" }, "stateOrProvince": { "description": "The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.", "type": "string" }, "street": { "description": "The name of the street. Maximum length: 3000 characters.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.", "maxLength": 3000, "type": "string" } }, "required": [ "street", "houseNumberOrName", "city", "postalCode", "country" ], "type": "object" }, "Amount": { "properties": { "currency": { "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", "maxLength": 3, "minLength": 3, "type": "string" }, "value": { "description": "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", "format": "int64", "type": "integer" } }, "required": [ "value", "currency" ], "type": "object" }, "ApplicationInfo": { "properties": { "adyenLibrary": { "description": "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", "$ref": "#/$defs/CommonField" }, "adyenPaymentSource": { "description": "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", "$ref": "#/$defs/CommonField" }, "externalPlatform": { "description": "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", "$ref": "#/$defs/ExternalPlatform" }, "merchantApplication": { "description": "Merchant developed software, such as cashier application, used to interact with the Adyen API.", "$ref": "#/$defs/CommonField" }, "merchantDevice": { "description": "Merchant device information.", "$ref": "#/$defs/MerchantDevice" }, "shopperInteractionDevice": { "description": "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref": "#/$defs/ShopperInteractionDevice" } }, "type": "object" }, "BrowserInfo": { "properties": { "acceptHeader": { "description": "The accept header value of the shopper's browser.", "type": "string" }, "colorDepth": { "x-addedInVersion": "40", "description": "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.", "format": "int32", "type": "integer" }, "javaEnabled": { "x-addedInVersion": "40", "description": "Boolean value indicating if the shopper's browser is able to execute Java.", "type": "boolean" }, "javaScriptEnabled": { "x-addedInVersion": "40", "default": true, "description": "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.", "type": "boolean" }, "language": { "x-addedInVersion": "40", "description": "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type": "string" }, "screenHeight": { "x-addedInVersion": "40", "description": "The total height of the shopper's device screen in pixels.", "format": "int32", "type": "integer" }, "screenWidth": { "x-addedInVersion": "40", "description": "The total width of the shopper's device screen in pixels.", "format": "int32", "type": "integer" }, "timeZoneOffset": { "x-addedInVersion": "40", "description": "Time difference between UTC time and the shopper's browser local time, in minutes.", "format": "int32", "type": "integer" }, "userAgent": { "description": "The user agent value of the shopper's browser.", "type": "string" } }, "required": [ "userAgent", "acceptHeader", "javaEnabled", "colorDepth", "screenHeight", "screenWidth", "timeZoneOffset", "language" ], "type": "object" }, "CommonField": { "properties": { "name": { "description": "Name of the field. For example, Name of External Platform.", "type": "string" }, "version": { "description": "Version of the field. For example, Version of External Platform.", "type": "string" } }, "type": "object" }, "DeviceRenderOptions": { "properties": { "sdkInterface": { "default": "both", "description": "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", "enum": [ "native", "html", "both" ], "type": "string" }, "sdkUiType": { "description": "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", "items": { "enum": [ "multiSelect", "otherHtml", "outOfBand", "singleSelect", "text" ], "type": "string" }, "type": "array" } }, "type": "object" }, "ExternalPlatform": { "properties": { "integrator": { "description": "External platform integrator.", "type": "string" }, "name": { "description": "Name of the field. For example, Name of External Platform.", "type": "string" }, "version": { "description": "Version of the field. For example, Version of External Platform.", "type": "string" } }, "type": "object" }, "ForexQuote": { "properties": { "account": { "description": "The account name.", "type": "string" }, "accountType": { "description": "The account type.", "type": "string" }, "baseAmount": { "description": "The base amount.", "$ref": "#/$defs/Amount" }, "basePoints": { "description": "The base points.", "format": "int32", "type": "integer" }, "buy": { "description": "The buy rate.", "$ref": "#/$defs/Amount" }, "interbank": { "description": "The interbank amount.", "$ref": "#/$defs/Amount" }, "reference": { "description": "The reference assigned to the forex quote request.", "type": "string" }, "sell": { "description": "The sell rate.", "$ref": "#/$defs/Amount" }, "signature": { "description": "The signature to validate the integrity.", "type": "string" }, "source": { "description": "The source of the forex quote.", "type": "string" }, "type": { "description": "The type of forex.", "type": "string" }, "validTill": { "description": "The date until which the forex quote is valid.", "format": "date-time", "type": "string" } }, "required": [ "validTill", "basePoints" ], "type": "object" }, "Installments": { "properties": { "plan": { "x-addedInVersion": "64", "description": "The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:\n* **regular**\n* **revolving**\n", "enum": [ "regular", "revolving" ], "type": "string" }, "value": { "description": "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, 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.", "format": "int32", "type": "integer" } }, "required": [ "value" ], "type": "object" }, "MerchantDevice": { "properties": { "os": { "description": "Operating system running on the merchant device.", "type": "string" }, "osVersion": { "description": "Version of the operating system on the merchant device.", "type": "string" }, "reference": { "description": "Merchant device reference.", "type": "string" } }, "type": "object" }, "MerchantRiskIndicator": { "properties": { "addressMatch": { "description": "Whether the chosen delivery address is identical to the billing address.", "type": "boolean" }, "deliveryAddressIndicator": { "description": "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", "enum": [ "shipToBillingAddress", "shipToVerifiedAddress", "shipToNewAddress", "shipToStore", "digitalGoods", "goodsNotShipped", "other" ], "type": "string" }, "deliveryEmail": { "deprecated": true, "x-deprecatedInVersion": "68", "x-deprecatedMessage": "Use `deliveryEmailAddress` instead.", "description": "The delivery email address (for digital goods).", "type": "string" }, "deliveryEmailAddress": { "x-addedInVersion": "68", "description": "For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters.", "maxLength": 254, "type": "string" }, "deliveryTimeframe": { "description": "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", "enum": [ "electronicDelivery", "sameDayShipping", "overnightShipping", "twoOrMoreDaysShipping" ], "type": "string" }, "giftCardAmount": { "description": "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", "$ref": "#/$defs/Amount" }, "giftCardCount": { "description": "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", "format": "int32", "type": "integer" }, "giftCardCurr": { "x-addedInVersion": "68", "description": "For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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.", "type": "string" }, "preOrderDate": { "description": "For pre-order purchases, the expected date this product will be available to the shopper.", "format": "date-time", "type": "string" }, "preOrderPurchase": { "description": "Indicator for whether this transaction is for pre-ordering a product.", "type": "boolean" }, "preOrderPurchaseInd": { "x-addedInVersion": "68", "description": "Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.", "type": "string" }, "reorderItems": { "description": "Indicator for whether the shopper has already purchased the same items in the past.", "type": "boolean" }, "reorderItemsInd": { "x-addedInVersion": "68", "description": "Indicates whether the cardholder is reordering previously purchased merchandise.", "type": "string" }, "shipIndicator": { "x-addedInVersion": "68", "description": "Indicates shipping method chosen for the transaction.", "type": "string" } }, "type": "object" }, "Name": { "properties": { "firstName": { "description": "The first name.", "type": "string" }, "lastName": { "description": "The last name.", "type": "string" } }, "required": [ "firstName", "lastName" ], "type": "object" }, "Phone": { "properties": { "cc": { "description": "Country code. Length: 13 characters.", "maxLength": 3, "minLength": 1, "type": "string" }, "subscriber": { "description": "Subscriber number. Maximum length: 15 characters.", "maxLength": 15, "type": "string" } }, "type": "object" }, "Recurring": { "properties": { "contract": { "description": "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n* `RECURRING` Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n* `ONECLICK,RECURRING` Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).", "enum": [ "ONECLICK", "RECURRING", "PAYOUT" ], "type": "string" }, "recurringDetailName": { "description": "A descriptive name for this detail.", "type": "string" }, "recurringExpiry": { "x-addedInVersion": "40", "description": "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format": "date-time", "type": "string" }, "recurringFrequency": { "x-addedInVersion": "40", "description": "Minimum number of days between authorisations. Only for 3D Secure 2.", "type": "string" }, "tokenService": { "x-addedInVersion": "25", "description": "The name of the token service.", "enum": [ "VISATOKENSERVICE", "MCTOKENSERVICE", "AMEXTOKENSERVICE", "TOKEN_SHARING" ], "type": "string" } }, "type": "object" }, "SDKEphemPubKey": { "properties": { "crv": { "description": "The `crv` value as received from the 3D Secure 2 SDK.", "type": "string" }, "kty": { "description": "The `kty` value as received from the 3D Secure 2 SDK.", "type": "string" }, "x": { "description": "The `x` value as received from the 3D Secure 2 SDK.", "type": "string" }, "y": { "description": "The `y` value as received from the 3D Secure 2 SDK.", "type": "string" } }, "type": "object" }, "ShopperInteractionDevice": { "properties": { "locale": { "description": "Locale on the shopper interaction device.", "type": "string" }, "os": { "description": "Operating system running on the shopper interaction device.", "type": "string" }, "osVersion": { "description": "Version of the operating system on the shopper interaction device.", "type": "string" } }, "type": "object" }, "Split": { "properties": { "account": { "description": "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type": "string" }, "amount": { "description": "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", "$ref": "#/$defs/SplitAmount" }, "description": { "description": "Your description for the split item.", "type": "string" }, "reference": { "description": "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor 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.", "type": "string" }, "type": { "description": "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", "enum": [ "AcquiringFees", "AdyenCommission", "AdyenFees", "AdyenMarkup", "BalanceAccount", "Commission", "Default", "Interchange", "MarketPlace", "PaymentFee", "Remainder", "SchemeFee", "Surcharge", "Tip", "VAT" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "SplitAmount": { "properties": { "currency": { "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.", "maxLength": 3, "minLength": 3, "type": "string" }, "value": { "description": "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", "format": "int64", "type": "integer" } }, "required": [ "value" ], "type": "object" }, "ThreeDS2RequestData": { "properties": { "acctInfo": { "x-addedInVersion": "68", "description": "Additional information about the Cardholders account provided by the 3DS Requestor.", "$ref": "#/$defs/AcctInfo" }, "acctType": { "x-addedInVersion": "68", "description": "Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values:\n* **01** Not applicable\n* **02** Credit\n* **03** Debit", "enum": [ "01", "02", "03" ], "maxLength": 2, "minLength": 2, "type": "string" }, "acquirerBIN": { "x-addedInVersion": "49", "description": "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). 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.", "type": "string" }, "acquirerMerchantID": { "x-addedInVersion": "49", "description": "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). 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.", "type": "string" }, "addrMatch": { "x-addedInVersion": "68", "description": "Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values:\n* **Y** Shipping Address matches Billing Address.\n* **N** Shipping Address does not match Billing Address.", "enum": [ "Y", "N" ], "maxLength": 1, "minLength": 1, "type": "string" }, "authenticationOnly": { "deprecated": true, "x-deprecatedInVersion": "50", "x-deprecatedMessage": "Use `threeDSAuthenticationOnly` instead.", "default": false, "description": "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", "type": "boolean" }, "challengeIndicator": { "deprecated": true, "x-deprecatedInVersion": "68", "x-deprecatedMessage": "Use `threeDSRequestorChallengeInd` instead.", "description": "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", "enum": [ "noPreference", "requestNoChallenge", "requestChallenge", "requestChallengeAsMandate" ], "type": "string" }, "deviceChannel": { "description": "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", "type": "string" }, "deviceRenderOptions": { "description": "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", "$ref": "#/$defs/DeviceRenderOptions" }, "homePhone": { "x-addedInVersion": "68", "description": "The home phone number provided by the Cardholder.", "$ref": "#/$defs/Phone" }, "mcc": { "x-addedInVersion": "49", "description": "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type": "string" }, "merchantName": { "x-addedInVersion": "49", "description": "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). 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.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-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.", "type": "string" }, "messageVersion": { "description": "The `messageVersion` value indicating the 3D Secure 2 protocol version.", "type": "string" }, "mobilePhone": { "x-addedInVersion": "68", "description": "The mobile phone number provided by the Cardholder.", "$ref": "#/$defs/Phone" }, "notificationURL": { "description": "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**.", "type": "string" }, "payTokenInd": { "x-addedInVersion": "68", "description": "Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS.", "type": "boolean" }, "paymentAuthenticationUseCase": { "x-addedInVersion": "68", "description": "Indicates the type of payment for which an authentication is requested (message extension)", "type": "string" }, "platform": { "description": "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", "enum": [ "iOS", "android", "browser" ], "type": "string" }, "purchaseInstalData": { "x-addedInVersion": "68", "description": "Indicates the maximum number of authorisations permitted for instalment payments. Length: 13 characters.", "maxLength": 3, "minLength": 1, "type": "string" }, "recurringExpiry": { "x-addedInVersion": "68", "description": "Date after which no further authorisations shall be performed. Format: YYYYMMDD", "type": "string" }, "recurringFrequency": { "x-addedInVersion": "68", "description": "Indicates the minimum number of days between authorisations. Maximum length: 4 characters.", "maxLength": 4, "type": "string" }, "sdkAppID": { "description": "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type": "string" }, "sdkEncData": { "description": "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type": "string" }, "sdkEphemPubKey": { "description": "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "$ref": "#/$defs/SDKEphemPubKey" }, "sdkMaxTimeout": { "default": 60, "description": "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", "format": "int32", "type": "integer" }, "sdkReferenceNumber": { "description": "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", "type": "string" }, "sdkTransID": { "description": "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", "type": "string" }, "sdkVersion": { "x-addedInVersion": "40", "description": "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type": "string" }, "threeDSCompInd": { "description": "Completion indicator for the device fingerprinting.", "type": "string" }, "threeDSRequestorAuthenticationInd": { "x-addedInVersion": "68", "description": "Indicates the type of Authentication request.", "type": "string" }, "threeDSRequestorAuthenticationInfo": { "x-addedInVersion": "68", "description": "Information about how the 3DS Requestor authenticated the cardholder before or during the transaction", "$ref": "#/$defs/ThreeDSRequestorAuthenticationInfo" }, "threeDSRequestorChallengeInd": { "x-addedInVersion": "68", "description": "Indicates whether a challenge is requested for this transaction. Possible values:\n* **01** No preference\n* **02** No challenge requested\n* **03** Challenge requested (3DS Requestor preference)\n* **04** Challenge requested (Mandate)\n* **05** No challenge (transactional risk analysis is already performed)\n* **06** Data Only", "enum": [ "01", "02", "03", "04", "05", "06" ], "type": "string" }, "threeDSRequestorID": { "description": "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", "type": "string" }, "threeDSRequestorName": { "description": "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", "type": "string" }, "threeDSRequestorPriorAuthenticationInfo": { "x-addedInVersion": "68", "description": "Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.", "$ref": "#/$defs/ThreeDSRequestorPriorAuthenticationInfo" }, "threeDSRequestorURL": { "description": "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", "type": "string" }, "transType": { "x-addedInVersion": "68", "description": "Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values:\n* **01** Goods/Service Purchase\n* **03** Check Acceptance\n* **10** Account Funding\n* **11** Quasi-Cash Transaction\n* **28** Prepaid Activation and Load", "enum": [ "01", "03", "10", "11", "28" ], "maxLength": 2, "minLength": 2, "type": "string" }, "transactionType": { "x-addedInVersion": "50", "description": "Identify the type of the transaction being authenticated.", "enum": [ "goodsOrServicePurchase", "checkAcceptance", "accountFunding", "quasiCashTransaction", "prepaidActivationAndLoad" ], "type": "string" }, "whiteListStatus": { "x-addedInVersion": "49", "description": "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type": "string" }, "workPhone": { "x-addedInVersion": "68", "description": "The work phone number provided by the Cardholder.", "$ref": "#/$defs/Phone" } }, "required": [ "deviceChannel" ], "type": "object" }, "ThreeDSRequestorAuthenticationInfo": { "properties": { "threeDSReqAuthData": { "description": "Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.", "type": "string" }, "threeDSReqAuthMethod": { "description": "Mechanism used by the Cardholder to authenticate to the 3DS Requestor. Allowed values:\n* **01** No 3DS Requestor authentication occurred (for example, cardholder logged in as guest).\n* **02** Login to the cardholder account at the 3DS Requestor system using 3DS Requestors own credentials.\n* **03** Login to the cardholder account at the 3DS Requestor system using federated ID.\n* **04** Login to the cardholder account at the 3DS Requestor system using issuer credentials.\n* **05** Login to the cardholder account at the 3DS Requestor system using third-party authentication.\n* **06** Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator.", "enum": [ "01", "02", "03", "04", "05", "06" ], "maxLength": 2, "minLength": 2, "type": "string" }, "threeDSReqAuthTimestamp": { "description": "Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM", "maxLength": 12, "minLength": 12, "type": "string" } }, "type": "object" }, "ThreeDSRequestorPriorAuthenticationInfo": { "properties": { "threeDSReqPriorAuthData": { "description": "Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.", "type": "string" }, "threeDSReqPriorAuthMethod": { "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values:\n* **01** Frictionless authentication occurred by ACS.\n* **02** Cardholder challenge occurred by ACS.\n* **03** AVS verified.\n* **04** Other issuer methods.", "enum": [ "01", "02", "03", "04" ], "maxLength": 2, "minLength": 2, "type": "string" }, "threeDSReqPriorAuthTimestamp": { "description": "Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM", "maxLength": 12, "minLength": 12, "type": "string" }, "threeDSReqPriorRef": { "description": "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.", "maxLength": 36, "minLength": 36, "type": "string" } }, "type": "object" } } }