{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/PaymentMethodsRequest", "title": "PaymentMethodsRequest", "properties": { "additionalData": { "additionalProperties": { "type": "string" }, "x-anyOf": [ { "$ref": "#/components/schemas/AdditionalData3DSecure" }, { "$ref": "#/components/schemas/AdditionalDataAirline" }, { "$ref": "#/components/schemas/AdditionalDataCarRental" }, { "$ref": "#/components/schemas/AdditionalDataCommon" }, { "$ref": "#/components/schemas/AdditionalDataLevel23" }, { "$ref": "#/components/schemas/AdditionalDataLodging" }, { "$ref": "#/components/schemas/AdditionalDataOpenInvoice" }, { "$ref": "#/components/schemas/AdditionalDataOpi" }, { "$ref": "#/components/schemas/AdditionalDataRatepay" }, { "$ref": "#/components/schemas/AdditionalDataRetry" }, { "$ref": "#/components/schemas/AdditionalDataRisk" }, { "$ref": "#/components/schemas/AdditionalDataRiskStandalone" }, { "$ref": "#/components/schemas/AdditionalDataSubMerchant" }, { "$ref": "#/components/schemas/AdditionalDataTemporaryServices" }, { "$ref": "#/components/schemas/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" }, "allowedPaymentMethods": { "x-addedInVersion": "33", "description": "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items": { "type": "string" }, "type": "array" }, "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": "#/components/schemas/Amount" }, "blockedPaymentMethods": { "x-addedInVersion": "33", "description": "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items": { "type": "string" }, "type": "array" }, "channel": { "description": "The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values:\n* iOS\n* Android\n* Web", "enum": [ "iOS", "Android", "Web" ], "type": "string" }, "countryCode": { "description": "The shopper's country code.", "type": "string" }, "merchantAccount": { "description": "The merchant account identifier, with which you want to process the transaction.", "type": "string" }, "order": { "x-addedInVersion": "64", "description": "The order information required for partial payments.", "$ref": "#/components/schemas/EncryptedOrderData" }, "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" }, "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" }, "splitCardFundingSources": { "x-addedInVersion": "53", "default": false, "description": "Boolean value indicating whether the card payment method should be split into separate debit and credit options.", "type": "boolean" }, "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" } }, "required": [ "merchantAccount" ], "type": "object" }