Request a payment method

post/merchants/{merchantId}/paymentMethodSettings

API Version

Sends a request to add a new payment method to the merchant account identified in the path. Depending the payment method type, you may need to send an additional object required for the payment method.

To make this request, your API credential must have the following role:

Management API—Payment methods read and write

Endpoint destination URL

https://management-test.adyen.com/v3/merchants/{merchantId}/paymentMethodSettings

Path Parameters

Required

Optional

The unique identifier of the merchant account.

Request Parameters

Required

Optional

Details to provide if type is accel.

Details to provide if type is affirm.

Details to provide if type is afterpaytouch.

Details to provide if type is alipay_plus.

Details to provide if type is amex.

Details to provide if type is applepay.

Details to provide if type is bcmc (Bancontact).

The unique identifier of the business line. Required if you are a platform model.

Details to provide if type is cartesbancaire.

Details to provide if type is clearpay.

The list of countries where a payment method is available. By default, all countries supported by the payment method.

Details to provide if type is cup (China Union Pay).

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.

Details to provide if type is diners. 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.

Details to provide if type is discover. For merchants operating in Japan, request Diners payment method instead. Discover is automatically requested, together with Diners.

Details to provide if type is eft_directdebit_CA (EFT PAD).

Details to provide if type is eftpos_australia.

Details to provide if type is girocard.

Details to provide if type is givex.

Details to provide if type is googlepay.

Details to provide if type is ideal.

Details to provide if type is interac_card.

Details to provide if type is jcb. For merchants operating in Japan, midNumber, reuseMidNumber, and serviceLevel fields are required. For merchants operating outside of Japan, these fields are not required.

Max length: 14

MID (Merchant ID) number. Required for merchants operating in Japan or merchants operating in Canada, Australia and New Zealand when requesting gatewayContract or paymentDesignatorContract service levels.Format: 14 numeric characters for Japan, 10 numeric characters for Canada, Australia and New Zealand.

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 for merchants operating in Japan or American Express for merchants operating in Canada, Australia and New Zealand.
gatewayContract: JCB or American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
paymentDesignatorContract: Available only for merchants operating in Canada, Australia and New Zealand. Adyen receives the settlement, and handles disputes and payouts.

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

Details to provide if type is klarna.

Details to provide if type is maestro. In the US, maestro is not supported; use maestro_usa instead.

Details to provide if type is maestro_usa. Only for Maestro USA, otherwise use maestro.

Details to provide if type is mc.

Details to provide if type is mealVoucher_FR.

Details to provide if type is nyce.

Details to provide if type is paybybank_plaid.

Details to provide if type is payme.

Details to provide if type is paypal.

Details to provide if type is payto.

Details to provide if type is pulse.

Max length: 150

Your reference for the payment method. Supported characters a-z, A-Z, 0-9.

Details to provide if type is sepadirectdebit.

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.

Details to provide if type is sodexo.

Sofort details.

Details to provide if type is star.

The unique identifier of the store for which to configure the payment method, if any.

Details to provide if type is svs.

Details to provide if type is swish.

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.

Details to provide if type is ticket (Edenred Brazil).

Details to provide if type is twint.

Payment method variant.

Details to provide if type is valuelink.

Details to provide if type is vipps.

Details to provide if type is visa.

Details to provide if type is wechatpay.

Details to provide if type is wechatpay_pos.

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.
accelobject
Details to provide if type is accel.
processingTypestring
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 recurringProcessingModel Subscription.

ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

affirmobject
Details to provide if type is affirm.
pricePlanstring
Merchant price plan
supportEmailstring
Merchant support email
afterpayTouchobject
Details to provide if type is afterpaytouch.
supportEmailstring
Support Email
supportUrlstring
Support Url
alipayPlusobject
Details to provide if type is alipay_plus.
settlementCurrencyCodestring
The currency used for settlement. Defaults to USD.
allowedboolean
Indicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.
amexobject
Details to provide if type is amex.
midNumberstring
Max length: 10
Merchant ID (MID) number. Format: 10 numeric characters. You must provide this field when you request gatewayContract or paymentDesignatorContract service levels.
reuseMidNumberboolean
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.
serviceLevelstring
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.

applePayobject
Details to provide if type is applepay.
domainsarray[string]
The list of merchant domains. Maximum: 99 domains per request.

For more information, see Apple Pay documentation.
bcmcobject
Details to provide if type is bcmc (Bancontact).
enableBcmcMobileboolean
Indicates if Bancontact mobile is enabled.
businessLineIdstring
The unique identifier of the business line. Required if you are a platform model.
cartesBancairesobject
Details to provide if type is cartesbancaire.
siretstring
Cartes Bancaires SIRET. Format: 14 digits.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

clearpayobject
Details to provide if type is clearpay.
supportUrlstring
Support Url
countriesarray[string]
The list of countries where a payment method is available. By default, all countries supported by the payment method.
cupobject
Details to provide if type is cup (China Union Pay).
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

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.
dinersobject
Details to provide if type is diners. 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.
midNumberstring
Max length: 14
MID (Merchant ID) number. Required for merchants operating in Japan. Format: 14 numeric characters.
reuseMidNumberboolean
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.
serviceLevelstring
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.

transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

discoverobject
Details to provide if type is discover. For merchants operating in Japan, request Diners payment method instead. Discover is automatically requested, together with Diners.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

eft_directdebit_CAobject
Details to provide if type is eft_directdebit_CA (EFT PAD).
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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_australiaobject
Details to provide if type is eftpos_australia.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

enabledboolean
Indicates whether the payment method is enabled (true) or disabled (false).
girocardobject
Details to provide if type is girocard.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

givexobject
Details to provide if type is givex.
currencyCodestring
The three-character ISO currency code, such as EUR.
passwordstring
The password provided by the acquirer.
paymentFlowstring
The sales channel used for the payment.
usernamestring
The username provided by the acquirer.
googlePayobject
Details to provide if type is googlepay.
merchantIdstring
Min length: 16Max length: 20
Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.
reuseMerchantIdboolean
Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: false.
idstring
The identifier of the resource.
idealobject
Details to provide if type is ideal.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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_cardobject
Details to provide if type is interac_card.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

jcbobject
Details to provide if type is jcb. For merchants operating in Japan, midNumber, reuseMidNumber, and serviceLevel fields are required. For merchants operating outside of Japan, these fields are not required.
midNumberstring
Max length: 14
MID (Merchant ID) number. Required for merchants operating in Japan or merchants operating in Canada, Australia and New Zealand when requesting gatewayContract or paymentDesignatorContract service levels.Format: 14 numeric characters for Japan, 10 numeric characters for Canada, Australia and New Zealand.
reuseMidNumberboolean
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.
serviceLevelstring
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 for merchants operating in Japan or American Express for merchants operating in Canada, Australia and New Zealand.

gatewayContract: JCB or American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.

paymentDesignatorContract: Available only for merchants operating in Canada, Australia and New Zealand. Adyen receives the settlement, and handles disputes and payouts.

transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

klarnaobject
Details to provide if type is klarna.
autoCaptureboolean
Indicates the status of Automatic capture. Default value: false.
disputeEmailstring
The email address for disputes.
regionstring
Min length: 2Max length: 2
The region of operation. For example, NA, EU, CH, AU.
supportEmailstring
The email address of merchant support.
maestroobject
Details to provide if type is maestro. In the US, maestro is not supported; use maestro_usa instead.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

maestro_usaobject
Details to provide if type is maestro_usa. Only for Maestro USA, otherwise use maestro.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

mcobject
Details to provide if type is mc.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

mealVoucher_FRobject
Details to provide if type is mealVoucher_FR.
conecsIdstring
Meal Voucher conecsId. Format: digits only
siretstring
Min length: 14Max length: 14
Meal 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.
nyceobject
Details to provide if type is nyce.
processingTypestring
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 recurringProcessingModel Subscription.

ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

paybybank_plaidobject
Details to provide if type is paybybank_plaid.
logostring
Merchant logo (max. size 150kB). Format: Base64-encoded string.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

paymeobject
Details to provide if type is payme.
displayNamestring
Merchant display name
logostring
Merchant logo. Format: Base64-encoded string.
supportEmailstring
The email address of merchant support.
paypalobject
Details to provide if type is paypal.
directCaptureboolean
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.
payerIdstring
Min length: 13Max length: 13
PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.
subjectstring
Your business email address.
paytoobject
Details to provide if type is payto.
merchantNamestring
Merchant name displayed to the shopper in the Agreements
payToPurposestring
Represents the purpose of the Agreements created, it relates to the business type Allowed values: mortgage, utility, loan, gambling, retail, salary, personal, government, pension, tax, other
pulseobject
Details to provide if type is pulse.
processingTypestring
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 recurringProcessingModel Subscription.

ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

referencestring
Max length: 150
Your reference for the payment method. Supported characters a-z, A-Z, 0-9.
sepadirectdebitobject
Details to provide if type is sepadirectdebit.
creditorIdstring
Creditor id
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

shopperInteractionstring
The sales channel.
sodexoobject
Details to provide if type is sodexo.
merchantContactPhonestring
Sodexo merchantContactPhone
sofortobjectDeprecated in version 1
Sofort details.
currencyCodestring
Sofort currency code. For example, EUR.
logostring
Sofort logo. Format: Base64-encoded string.
starobject
Details to provide if type is star.
processingTypestring
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 recurringProcessingModel Subscription.

ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

storeIdsarray[string]
The unique identifier of the store for which to configure the payment method, if any.
svsobject
Details to provide if type is svs.
authorisationMidstring
The merchant ID (MID) that the acquirer recognizes you by.
currencyCodestring
The three-character ISO currency code, example USD
swishobject
Details to provide if type is swish.

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.

swishNumberstring
Min length: 10Max length: 10
Swish number. Format: 10 digits without spaces. For example, 1231111111.
ticketobject
Details to provide if type is ticket (Edenred Brazil).
requestorIdstring
Ticket requestorId
twintobject
Details to provide if type is twint.
logostring
Twint logo. Format: Base64-encoded string.
typestring
Payment method variant.
valuelinkobject
Details to provide if type is valuelink.
authorisationMidstring
Authorisation Mid
pinSupportstring
PIN Support. For ecommerce, PIN is required.
submitterIdstring
Submitter ID
terminalIdstring
Terminal ID
verificationStatusstring
Payment method status. Possible values:

valid

pending

invalid

rejected

vippsobject
Details to provide if type is vipps.
logostring
Vipps logo. Format: Base64-encoded string.
subscriptionCancelUrlstring
Vipps subscription cancel url (required in case of recurring payments)
visaobject
Details to provide if type is visa.
transactionDescriptionobject
Information regarding the transaction description.

You cannot configure the transaction description in the test environment.

doingBusinessAsNamestring
Max length: 22
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 . , ' _ - ? + * /.
typestring
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.

wechatpayobject
Details to provide if type is wechatpay.
contactPersonNamestring
The name of the contact person from merchant support.
emailstring
The email address of merchant support.
wechatpay_posobject
Details to provide if type is wechatpay_pos.
contactPersonNamestring
The name of the contact person from merchant support.
emailstring
The 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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
429
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A 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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Request a payment method

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

429

500 - Internal Server Error