POST /merchants/{merchantId}/paymentMethodSettings

The unique identifier of the merchant account.

Default value: "application/json"

Sodexo details.

Sodexo merchantContactPhone

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

WeChat Pay details.

The email address of merchant support.

The name of the contact person from merchant support.

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Your business email address.

PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.

Afterpay Touch details.

Support Url

Google Pay details.

Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: false.

Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

Klarna details.

The region of operation. For example, NA, EU, CH, AU.

Possible values:

• "EU"
• "CH"
• "AU"
• "NA"

The email address for disputes.

Indicates the status of Automatic capture. Default value: false.

The email address of merchant support.

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

NYCE 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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Possible values:

• "pos"
• "ecom"
• "billpay"

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.

Possible values:

• "contAuth"
• "pos"
• "eCommerce"
• "moto"

Sofort details.

Sofort currency code. For example, EUR.

Sofort logo. Format: Base64-encoded string.

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

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

The list of custom routing flags to route payment to the intended acquirer.

ACCEL 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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Possible values:

• "pos"
• "ecom"
• "billpay"

Payment method variant.

Possible values:

• "credtodos"
• "applepay"
• "elodebit"
• "jcb"
• "directdebit_GB"
• "mcdebit"
• "vipps"
• "bcmc"
• "elo"
• "up_brazil_credit"
• "afterpaytouch"
• "interac_card"
• "banese_card_prepaid"
• "pulse"
• "ebanking_FI"
• "mealVoucher_FR"
• "klarna"
• "star"
• "payme_pos"
• "vale_refeicao"
• "eftpos_australia"
• "paypal"
• "trustly"
• "visa"
• "alipay_hk"
• "klarna_account"
• "payshop"
• "onlineBanking_PL"
• "clicktopay"
• "nyce"
• "ticket"
• "vpay"
• "paynow_pos"
• "affirm"
• "credtodos_private_credit"
• "googlepay"
• "todo_giftcard"
• "mobilepay"
• "vale_refeicao_prepaid"
• "sodexo"
• "wechatpay_pos"
• "payme"
• "girocard"
• "blik"
• "visadebit"
• "cup"
• "amex"
• "hiper"
• "paynow"
• "alipay"
• "cartebancaire"
• "diners"
• "maestro"
• "twint_pos"
• "credtodos_private_debit"
• "paybybank"
• "banese_card"
• "swish"
• "accel"
• "clearpay"
• "elocredit"
• "banese_card_debit"
• "banese_card_credit"
• "discover"
• "hipercard"
• "klarna_paynow"
• "mbway"
• "mc"
• "alelo"
• "twint"
• "multibanco"
• "ideal"
• "wechatpay"

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

Twint details.

Twint logo. Format: Base64-encoded string.

WeChat Pay POS details.

The email address of merchant support.

The name of the contact person from merchant support.

Bancontact details.

Indicates if Bancontact mobile is enabled.

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

Vipps details.

Vipps logo. Format: Base64-encoded string.

Vipps subscription cancel url (required in case of recurring payments)

Meal Voucher FR details.

Meal Voucher siret. Format: 14 digits.

Meal Voucher conecsId. Format: digits only

The list of additional payment methods. Allowed values: mealVoucher_FR_edenred, mealVoucher_FR_groupeup, mealVoucher_FR_natixis, mealVoucher_FR_sodexo.

Apple Pay details.

The list of merchant domains. Maximum: 99 domains per request.

For more information, see Apple Pay documentation.

Edenred details.

Ticket requestorId

Clearpay details.

Support Url

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.

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.

Possible values:

• "noContract"
• "gatewayContract"

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Default value: false

MID (Merchant ID) number. Required for merchants operating in Japan. Format: 14 numeric characters.

PayMe details.

Merchant logo. Format: Base64-encoded string.

Merchant display name

The email address of merchant support.

PULSE 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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Possible values:

• "pos"
• "ecom"
• "billpay"

STAR 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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Possible values:

• "pos"
• "ecom"
• "billpay"

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

The list of currencies that a payment method supports. By default, all currencies supported by the payment method.

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

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

giropay details.

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

Amex details.

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.

Possible values:

• "paymentDesignatorContract"
• "noContract"
• "gatewayContract"

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.

Default value: false

Merchant ID (MID) number. Format: 10 numeric characters. You must provide this field when you request gatewayContract or paymentDesignatorContract service levels.

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

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.

Possible values:

• "noContract"
• "gatewayContract"

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.

Possible values:

• "fixed"
• "dynamic"
• "append"

Default value: "dynamic"

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.

Default value: false

MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.