Adyen · Schema
PaymentRequest3d
PaymentsFinancial ServicesFintechAgentic CommercePoint-of-SalePayment Processing
Properties
| Name | Type | Description |
|---|---|---|
| accountInfo | object | Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow. |
| additionalAmount | object | 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 th |
| additionalData | object | This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. |
| amount | object | 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/ |
| applicationInfo | object | Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). |
| billingAddress | object | The address where to send the invoice. > The `billingAddress` object is required in the following scenarios. Include all of the fields within this object. >* For 3D Secure 2 transactions in all browse |
| browserInfo | object | The shopper's browser information. > For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate that yo |
| captureDelayHours | integer | The delay between the authorisation and scheduled auto-capture, specified in hours. |
| dateOfBirth | string | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD |
| dccQuote | object | The forex quote as returned in the response of the forex service. |
| deliveryAddress | object | The address where the purchased goods should be delivered. |
| deliveryDate | string | The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 |
| deviceFingerprint | string | A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). |
| fraudOffset | integer | An integer value that is added to the normal fraud score. The value can be either positive or negative. |
| installments | object | Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). |
| localizedShopperStatement | object | The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement |
| mcc | string | 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 activi |
| md | string | The payment session identifier returned by the card issuer. |
| merchantAccount | string | The merchant account identifier, with which you want to process the transaction. |
| merchantOrderReference | string | This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference sho |
| merchantRiskIndicator | object | Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow. |
| metadata | object | Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". * Maxim |
| orderReference | string | 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 mu |
| paResponse | string | Payment authorisation response returned by the card issuer. The `paResponse` field holds the PaRes value received from the card issuer. |
| recurring | object | The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). |
| recurringProcessingModel | string | Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amou |
| reference | string | 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 require |
| selectedBrand | string | Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like |
| selectedRecurringDetailReference | string | The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. |
| sessionId | string | A session ID used to identify a payment session. |
| shopperEmail | string | The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and m |
| shopperIP | string | The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Se |
| shopperInteraction | string | Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction b |
| shopperLocale | string | The combination of a language code and a country code to specify the language to be used in the payment. |
| shopperName | object | The shopper's full name. |
| shopperReference | string | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identif |
| shopperStatement | string | The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, |
| socialSecurityNumber | string | The shopper's social security number. |
| splits | array | 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 [I |
| store | string | The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-p |
| telephoneNumber | string | The shopper's telephone number. |
| threeDS2RequestData | object | 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](h |
| threeDSAuthenticationOnly | boolean | 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. |
| totalsGroup | string | The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). |
| trustedShopper | boolean | Set to true if the payment should be routed to a trusted MID. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-payment-request3d-schema.json",
"title": "PaymentRequest3d",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/adyen-authorise3d-api-openapi.yml#/components/schemas/PaymentRequest3d",
"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"
},
"md": {
"description": "The payment session identifier returned by the card issuer.",
"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"
},
"paResponse": {
"description": "Payment authorisation response returned by the card issuer. The `paResponse` field holds the PaRes value received from the card issuer.",
"type": "string"
},
"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": "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).",
"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",
"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",
"paResponse",
"md"
],
"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** — 30–60 days\n* **05** — More than 60 days",
"enum": [
"01",
"02",
"03",
"04",
"05"
],
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"chAccChange": {
"description": "Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nFormat: **YYYYMMDD**",
"type": "string"
},
"chAccChangeInd": {
"description": "Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nAllowed values:\n* **01** — Changed during this transaction\n* **02** — Less than 30 days\n* **03** — 30–60 days\n* **04** — More than 60 days",
"enum": [
"01",
"02",
"03",
"04"
],
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"chAccPwChange": {
"description": "Date that cardholder’s 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 cardholder’s 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** — 30–60 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 cardholder’s account with the 3DS Requestor. \nFormat: **YYYYMMDD**",
"type": "string"
},
"paymentAccInd": {
"description": "Indicates the length of time that the payment account was enrolled in the cardholder’s 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** — 30–60 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** — 30–60 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": {
"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": {
"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
# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/adyen-payment-request3d-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/adyen-payment-request3d"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.