Request a payment method
Sends a request to add a new payment method to the merchant account identified in the path.
To make this request, your API credential must have the following role:
- Management API—Payment methods read and write
Path Parameters
The unique identifier of the merchant account.
Request Parameters
ACCEL details.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Afterpay Touch details.
Support Url
Amex details.
Merchant ID (MID) number. Format: 10 numeric characters.
You must provide this field when you request gatewayContract or paymentDesignatorContract service levels.
Indicates whether the Amex Merchant ID is reused from a previously setup Amex payment method.
This is only applicable for gatewayContract and paymentDesignatorContract service levels.
The default value is false.
Specifies the service level (settlement type) of this payment method. Possible values:
- noContract: Adyen holds the contract with American Express.
- gatewayContract: American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
- paymentDesignatorContract: Adyen receives the settlement, and handles disputes and payouts.
Apple Pay details.
The list of merchant domains. Maximum: 99 domains per request.
For more information, see Apple Pay documentation.
The unique identifier of the business line. Required if you are a platform model.
Cartes Bancaires details.
Cartes Bancaires SIRET. Format: 14 digits.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
The list of countries where a payment method is available. By default, all countries supported by the payment method.
China Union Pay details.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
The list of currencies that a payment method supports. By default, all currencies supported by the payment method.
The list of custom routing flags to route payment to the intended acquirer.
Diners details. For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include JCB-specific fields in this object.
MID (Merchant ID) number. Required for merchants operating in Japan. Format: 14 numeric characters.
Indicates whether the JCB Merchant ID is reused from a previously configured JCB payment method. The default value is false. For merchants operating in Japan, this field is required and must be set to true.
Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:
- noContract: Adyen holds the contract with JCB.
- gatewayContract: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Discover details. For merchants operating in Japan, request Diners payment method instead. Discover is automatically requested, together with Diners.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Eftpos Australia details.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
giropay details.
The email address of merchant support.
Girocard details.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Google Pay details.
Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.
Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: false.
iDeal details.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Interac Card details.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
JCB details.
For merchants operating in Japan, midNumber, reuseMidNumber, and serviceLevel fields are required.
For merchants operating outside of Japan, these fields are not required.
MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.
Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. The default value is false.For merchants operating in Japan, this field is required and must be set to true.
Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:
- noContract: Adyen holds the contract with JCB.
- gatewayContract: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Klarna details.
Indicates the status of Automatic capture. Default value: false.
The email address for disputes.
The region of operation. For example, NA, EU, CH, AU.
The email address of merchant support.
Maestro details. In the US, maestro is not supported; use maestro_usa instead.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
MasterCard details.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Meal Voucher FR details.
Meal Voucher conecsId. Format: digits only
Meal Voucher siret. Format: 14 digits.
The list of additional payment methods. Allowed values: mealVoucher_FR_edenred, mealVoucher_FR_groupeup, mealVoucher_FR_natixis, mealVoucher_FR_sodexo.
NYCE details.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
PayMe details.
Merchant display name
Merchant logo. Format: Base64-encoded string.
The email address of merchant support.
PayPal details.
Indicates if direct (immediate) capture for PayPal is enabled. If set to true, this setting overrides the capture settings of your merchant account. Default value: true.
PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.
Your business email address.
PULSE details.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
Your reference for the payment method. Supported characters a-z, A-Z, 0-9.
The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account.
Possible values: eCommerce, pos, contAuth, and moto.
Sodexo details.
Sodexo merchantContactPhone
Sofort details.
Sofort currency code. For example, EUR.
Sofort logo. Format: Base64-encoded string.
STAR details.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
The unique identifier of the store for which to configure the payment method, if any.
Swish details.
- This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).
- If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.
Swish number. Format: 10 digits without spaces. For example, 1231111111.
Twint details.
Twint logo. Format: Base64-encoded string.
Payment method variant.
Vipps details.
Vipps logo. Format: Base64-encoded string.
Vipps subscription cancel url (required in case of recurring payments)
Visa details.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
WeChat Pay details.
The name of the contact person from merchant support.
The email address of merchant support.
WeChat Pay POS details.
The name of the contact person from merchant support.
The email address of merchant support.
Response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200 - OK
The request has succeeded.
Show moreShow lessaccelobjectACCEL details.
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
allowedbooleanIndicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.
amexobjectAmex details.
midNumberstringMax length: 10Merchant ID (MID) number. Format: 10 numeric characters. You must provide this field when you request
gatewayContractorpaymentDesignatorContractservice levels.reuseMidNumberbooleanIndicates whether the Amex Merchant ID is reused from a previously setup Amex payment method. This is only applicable for
gatewayContractandpaymentDesignatorContractservice levels. The default value is false.serviceLevelstringSpecifies the service level (settlement type) of this payment method. Possible values:
- noContract: Adyen holds the contract with American Express.
- gatewayContract: American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
- paymentDesignatorContract: Adyen receives the settlement, and handles disputes and payouts.
applePayobjectApple Pay details.
domainsarray[string]The list of merchant domains. Maximum: 99 domains per request.
For more information, see Apple Pay documentation.
businessLineIdstringThe unique identifier of the business line. Required if you are a platform model.
cartesBancairesobjectCartes Bancaires details.
siretstringCartes Bancaires SIRET. Format: 14 digits.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
countriesarray[string]The list of countries where a payment method is available. By default, all countries supported by the payment method.
cupobjectChina Union Pay details.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
currenciesarray[string]The list of currencies that a payment method supports. By default, all currencies supported by the payment method.
customRoutingFlagsarray[string]The list of custom routing flags to route payment to the intended acquirer.
dinersobjectDiners details. For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include JCB-specific fields in this object.
midNumberstringMax length: 14MID (Merchant ID) number. Required for merchants operating in Japan. Format: 14 numeric characters.
reuseMidNumberbooleanIndicates whether the JCB Merchant ID is reused from a previously configured JCB payment method. The default value is false. For merchants operating in Japan, this field is required and must be set to true.
serviceLevelstringSpecifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:
- noContract: Adyen holds the contract with JCB.
- gatewayContract: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
discoverobjectDiscover details. For merchants operating in Japan, request Diners payment method instead. Discover is automatically requested, together with Diners.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
eftpos_australiaobjectEftpos Australia details.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
enabledbooleanIndicates whether the payment method is enabled (true) or disabled (false).
giroPayobjectgiropay details.
supportEmailstringThe email address of merchant support.
girocardobjectGirocard details.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
googlePayobjectGoogle Pay details.
merchantIdstringMin length: 16Max length: 20Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.
reuseMerchantIdbooleanIndicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: false.
idstringThe identifier of the resource.
idealobjectiDeal details.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
interac_cardobjectInterac Card details.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
jcbobjectJCB details. For merchants operating in Japan,
midNumber,reuseMidNumber, andserviceLevelfields are required. For merchants operating outside of Japan, these fields are not required.midNumberstringMax length: 14MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.
reuseMidNumberbooleanIndicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. The default value is false.For merchants operating in Japan, this field is required and must be set to true.
serviceLevelstringSpecifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:
- noContract: Adyen holds the contract with JCB.
- gatewayContract: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
klarnaobjectKlarna details.
autoCapturebooleanIndicates the status of Automatic capture. Default value: false.
disputeEmailstringThe email address for disputes.
regionstringMin length: 2Max length: 2The region of operation. For example, NA, EU, CH, AU.
supportEmailstringThe email address of merchant support.
maestroobjectMaestro details. In the US,
maestrois not supported; usemaestro_usainstead.transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
mcobjectMasterCard details.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
mealVoucher_FRobjectMeal Voucher FR details.
conecsIdstringMeal Voucher conecsId. Format: digits only
siretstringMin length: 14Max length: 14Meal Voucher siret. Format: 14 digits.
subTypesarray[string]The list of additional payment methods. Allowed values: mealVoucher_FR_edenred, mealVoucher_FR_groupeup, mealVoucher_FR_natixis, mealVoucher_FR_sodexo.
nyceobjectNYCE details.
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
paymeobjectPayMe details.
displayNamestringMerchant display name
logostringMerchant logo. Format: Base64-encoded string.
supportEmailstringThe email address of merchant support.
paypalobjectPayPal details.
directCapturebooleanIndicates if direct (immediate) capture for PayPal is enabled. If set to true, this setting overrides the capture settings of your merchant account. Default value: true.
payerIdstringMin length: 13Max length: 13PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.
subjectstringYour business email address.
pulseobjectPULSE details.
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
referencestringMax length: 150Your reference for the payment method. Supported characters a-z, A-Z, 0-9.
shopperInteractionstringThe sales channel.
sodexoobjectSodexo details.
merchantContactPhonestringSodexo merchantContactPhone
sofortobjectSofort details.
currencyCodestringSofort currency code. For example, EUR.
logostringSofort logo. Format: Base64-encoded string.
starobjectSTAR details.
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
storeIdsarray[string]The unique identifier of the store for which to configure the payment method, if any.
swishobjectSwish details.
- This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).
- If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.
swishNumberstringMin length: 10Max length: 10Swish number. Format: 10 digits without spaces. For example, 1231111111.
twintobjectTwint details.
logostringTwint logo. Format: Base64-encoded string.
typestringPayment method variant.
verificationStatusstringPayment method status. Possible values:
- valid
- pending
- invalid
- rejected
vippsobjectVipps details.
logostringVipps logo. Format: Base64-encoded string.
subscriptionCancelUrlstringVipps subscription cancel url (required in case of recurring payments)
visaobjectVisa details.
transactionDescriptionobjectInformation regarding the transaction description.
You cannot configure the transaction description in the test environment.
doingBusinessAsNamestringMax length: 22The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestringThe type of transaction description you want to use:
- fixed: The transaction description set in this request is used for all payments with this payment method.
- append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.
- dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.
wechatpayobjectWeChat Pay details.
contactPersonNamestringThe name of the contact person from merchant support.
emailstringThe email address of merchant support.
wechatpay_posobjectWeChat Pay POS details.
contactPersonNamestringThe name of the contact person from merchant support.
emailstringThe email address of merchant support.
204 - No Content
The request has been successfully processed, but there is no additional content.
400 - Bad Request
A problem reading or understanding the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
- Show moreShow less
429
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.