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:
Afterpay Touch details.
Apple Pay details.
The list of merchant domains. Maximum: 99 domains per request.
For more information, see Apple Pay documentation.
Bancontact details.
Indicates if Bancontact mobile is enabled.
Information regarding the transaction description.
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:
Cartes Bancaires details.
Information regarding the transaction description.
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:
Clearpay details.
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.
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:
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.
Information regarding the transaction description.
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:
Discover details.
Information regarding the transaction description.
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:
Eftpos Australia details.
Information regarding the transaction description.
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:
giropay details.
Girocard details.
Information regarding the transaction description.
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:
Google Pay details.
Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.
iDeal details.
Information regarding the transaction description.
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:
Interac Card details.
Information regarding the transaction description.
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:
JCB details.
Information regarding the transaction description.
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:
Klarna details.
Indicates the status of Automatic capture. Default value: false.
Maestro details.
Information regarding the transaction description.
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:
MasterCard details.
Information regarding the transaction description.
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:
Meal Voucher FR details.
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 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.
Sofort details.
The ID of the store, if any.
Swish details.
Twint details.
Payment method variant.
Vipps details.
Vipps subscription cancel url (required in case of recurring payments)
Visa details.
Information regarding the transaction description.
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:
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.
The request has succeeded.
Show more Show lessAfterpay Touch details.
Indicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.
Apple Pay details.
The list of merchant domains. Maximum: 99 domains per request.
For more information, see Apple Pay documentation.
Bancontact details.
Indicates if Bancontact mobile is enabled.
Information regarding the transaction description.
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:
Cartes Bancaires details.
Information regarding the transaction description.
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:
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.
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:
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.
Information regarding the transaction description.
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:
Discover details.
Information regarding the transaction description.
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:
Eftpos Australia details.
Information regarding the transaction description.
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:
giropay details.
Girocard details.
Information regarding the transaction description.
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:
Google Pay details.
Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.
iDeal details.
Information regarding the transaction description.
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:
Interac Card details.
Information regarding the transaction description.
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:
JCB details.
Information regarding the transaction description.
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:
Klarna details.
Indicates the status of Automatic capture. Default value: false.
Maestro details.
Information regarding the transaction description.
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:
MasterCard details.
Information regarding the transaction description.
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:
Meal Voucher FR details.
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 reference for the payment method. Supported characters a-z, A-Z, 0-9.
Sofort details.
The ID of the store, if any.
Swish details.
Twint details.
Payment method variant.
Vipps details.
Vipps subscription cancel url (required in case of recurring payments)
Visa details.
Information regarding the transaction description.
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: