Pricing Templates
Log in Sign up
Integrations / Adyen Management / ...

PATCH /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}

Updates payment method details for the merchant account and the payment method 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:

Servers

Path parameters

Name Type Required Description
paymentMethodId String Yes

The unique identifier of the payment method.
merchantId String Yes

The unique identifier of the merchant account.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
visa Object No

Details to provide if type is visa.
visa.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
visa.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
visa.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
cartesBancaires Object No

Details to provide if type is cartesbancaire.
cartesBancaires.siret String Yes

Cartes Bancaires SIRET. Format: 14 digits.
cartesBancaires.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
cartesBancaires.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
cartesBancaires.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
mc Object No

Details to provide if type is mc.
mc.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
mc.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
mc.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
eftpos_australia Object No

Details to provide if type is eftpos_australia.
eftpos_australia.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
eftpos_australia.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
eftpos_australia.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
nyce Object No

Details to provide if type is nyce.
nyce.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
nyce.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
nyce.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
nyce.processingType String Yes

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.

Valid values:

  • "pos"
  • "ecom"
  • "billpay"
sepadirectdebit Object No

Details to provide if type is sepadirectdebit.
sepadirectdebit.creditorId String No

Creditor id
sepadirectdebit.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
sepadirectdebit.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
sepadirectdebit.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
storeIds[] Array No

The list of stores for this payment method
discover Object No

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

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
discover.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
discover.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
customRoutingFlags[] Array No

Custom routing flags for acquirer routing.
maestro_usa Object No

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

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
maestro_usa.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
maestro_usa.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
accel Object No

Details to provide if type is accel.
accel.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
accel.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
accel.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
accel.processingType String Yes

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.

Valid values:

  • "pos"
  • "ecom"
  • "billpay"
eft_directdebit_CA Object No

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

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
eft_directdebit_CA.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
eft_directdebit_CA.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
paybybank_plaid Object No

Details to provide if type is paybybank_plaid.
paybybank_plaid.logo String No

Merchant logo (max. size 150kB). Format: Base64-encoded string.
paybybank_plaid.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
paybybank_plaid.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
paybybank_plaid.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
storeId String No

The store for this payment method
bcmc Object No

Details to provide if type is bcmc (Bancontact).
bcmc.enableBcmcMobile Boolean No

Indicates if Bancontact mobile is enabled.
interac_card Object No

Details to provide if type is interac_card.
interac_card.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
interac_card.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
interac_card.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
diners Object No

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.
diners.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
diners.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
diners.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
pulse Object No

Details to provide if type is pulse.
pulse.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
pulse.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
pulse.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
pulse.processingType String Yes

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.

Valid values:

  • "pos"
  • "ecom"
  • "billpay"
star Object No

Details to provide if type is star.
star.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
star.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
star.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
star.processingType String Yes

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.

Valid values:

  • "pos"
  • "ecom"
  • "billpay"
cup Object No

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

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
cup.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
cup.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
currencies[] Array No

The list of currencies that a payment method supports. By default, all currencies supported by the payment method.
countries[] Array No

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

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

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
maestro.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
maestro.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
enabled Boolean No

Indicates whether the payment method is enabled (true) or disabled (false).
ideal Object No

Details to provide if type is ideal.
ideal.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
ideal.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
ideal.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
girocard Object No

Details to provide if type is girocard.
girocard.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
girocard.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
girocard.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"
jcb Object No

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.
jcb.transactionDescription Object No

Information regarding the transaction description.

You cannot configure the transaction description in the test environment.
jcb.transactionDescription.doingBusinessAsName String No

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 . , ' _ - ? + * /.
jcb.transactionDescription.type String No

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.

Valid values:

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

Default value: "dynamic"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy