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

POST /merchants/{merchantId}/paymentMethodSettings

Sends a request to add a new payment method to the merchant account identified in the path.

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

Servers

Path parameters

Name Type Required Description
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
sodexo Object No

Sodexo details.
sodexo.merchantContactPhone String Yes

Sodexo merchantContactPhone
visa Object No

Visa details.
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"
swish Object No

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.swishNumber String Yes

Swish number. Format: 10 digits without spaces. For example, 1231111111.
wechatpay Object No

WeChat Pay details.
wechatpay.email String Yes

The email address of merchant support.
wechatpay.contactPersonName String Yes

The name of the contact person from merchant support.
affirm Object No

Affirm details.
affirm.supportEmail String Yes

Merchant support email
mc Object No

MasterCard details.
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"
sofort Object No

Sofort details.
sofort.currencyCode String Yes

Sofort currency code. For example, EUR.
sofort.logo String Yes

Sofort logo. Format: Base64-encoded string.
discover Object No

Discover details. 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"
maestro_usa Object No

Maestro USA details. Only for Maestro USA, for global 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"
type String Yes

Payment method variant.

Valid values:

  • "abrapetite_prepaid"
  • "le_card_credit"
  • "credtodos"
  • "green_card_prepaid"
  • "applepay"
  • "vero_card_credit"
  • "jcb"
  • "eft_directdebit_CA"
  • "directdebit_GB"
  • "vipps"
  • "bcmc"
  • "up_brazil_credit"
  • "interac_card"
  • "banese_card_prepaid"
  • "pulse"
  • "klarna"
  • "megaleve"
  • "payme_pos"
  • "vale_refeicao"
  • "megaleve_debit"
  • "eftpos_australia"
  • "paypal"
  • "trustly"
  • "alipay_hk"
  • "klarna_account"
  • "onlineBanking_PL"
  • "clicktopay"
  • "up_brazil_debit"
  • "green_card_food_prepaid"
  • "vegas_card_debit"
  • "vero_card_debit"
  • "nyce"
  • "ticket"
  • "abrapetite"
  • "romcard_credit"
  • "affirm"
  • "credtodos_private_credit"
  • "googlepay"
  • "up_brazil_prepaid"
  • "avancard_debit"
  • "vale_refeicao_prepaid"
  • "sepadirectdebit"
  • "avancard"
  • "payto"
  • "wechatpay_pos"
  • "cooper_credit"
  • "le_card"
  • "blik"
  • "abrapetite_debit"
  • "paynow"
  • "senff_credit"
  • "nutricash_prepaid"
  • "cartebancaire"
  • "diners"
  • "credtodos_private_debit"
  • "paybybank"
  • "banese_card"
  • "accel"
  • "clearpay"
  • "elocredit"
  • "alipay_plus"
  • "banese_card_debit"
  • "banese_card_credit"
  • "cooper_prepaid"
  • "cooper_debit"
  • "cooper_private_credit"
  • "hipercard"
  • "ach"
  • "cooper_food_debit"
  • "romcard_debit"
  • "le_card_debit"
  • "nutricash"
  • "multibanco"
  • "ideal"
  • "wechatpay"
  • "cooper_meal_debit"
  • "paybybank_plaid"
  • "megaleve_credit"
  • "br_schemes"
  • "elodebit"
  • "personal_card_debit"
  • "mcdebit"
  • "elo"
  • "alipay_wap"
  • "personal_card_credit"
  • "afterpaytouch"
  • "green_card_meal_prepaid"
  • "ebanking_FI"
  • "mealVoucher_FR"
  • "up_brazil"
  • "star"
  • "green_card"
  • "avancard_credit"
  • "visa"
  • "maxifrota"
  • "vegas_card_credit"
  • "romcard"
  • "vpay"
  • "paynow_pos"
  • "senff"
  • "todo_giftcard"
  • "mobilepay"
  • "sodexo"
  • "maxifrota_prepaid"
  • "payme"
  • "girocard"
  • "visadebit"
  • "cup"
  • "amex"
  • "hiper"
  • "personal_card"
  • "green_card_credit"
  • "green_card_debit"
  • "vero_card_prepaid"
  • "alipay"
  • "maestro"
  • "maestro_usa"
  • "twint_pos"
  • "abrapetite_credit"
  • "swish"
  • "cooper"
  • "discover"
  • "vero_card"
  • "klarna_paynow"
  • "cooper_retail_credit"
  • "mbway"
  • "mc"
  • "vegas_card"
  • "alelo"
  • "twint"
reference String No

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

Twint details.
twint.logo String Yes

Twint logo. Format: Base64-encoded string.
wechatpay_pos Object No

WeChat Pay POS details.
wechatpay_pos.email String Yes

The email address of merchant support.
wechatpay_pos.contactPersonName String Yes

The name of the contact person from merchant support.
paybybank_plaid Object No

PayByBank Plaid details.
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"
bcmc Object No

Bancontact details.
bcmc.enableBcmcMobile Boolean No

Indicates if Bancontact mobile is enabled.
applePay Object No

Apple Pay details.
applePay.domains[] Array Yes

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

For more information, see Apple Pay documentation.
clearpay Object No

Clearpay details.
clearpay.supportUrl String Yes

Support Url
diners Object No

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.
diners.serviceLevel String No

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.

Valid values:

  • "noContract"
  • "gatewayContract"
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"
diners.reuseMidNumber Boolean Yes

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
diners.midNumber String No

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

China Union Pay details.
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"
businessLineId String No

The unique identifier of the business line. Required if you are a platform model.
countries[] Array No

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

iDeal details.
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"
jcb Object No

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.
jcb.serviceLevel String No

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.

Valid values:

  • "paymentDesignatorContract"
  • "noContract"
  • "gatewayContract"
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"
jcb.reuseMidNumber Boolean No

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
jcb.midNumber String No

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.
payto Object No

PayTo details.
payto.payToPurpose String Yes

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
payto.merchantName String Yes

Merchant name displayed to the shopper in the Agreements
cartesBancaires Object No

Cartes Bancaires details.
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"
paypal Object No

PayPal details.
paypal.directCapture Boolean No

Indicates if direct (immediate) capture for PayPal is enabled. If set to true, this setting overrides the capture settings of your merchant account. Default value: true.
paypal.subject String Yes

Your business email address.
paypal.payerId String Yes

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

Afterpay Touch details.
afterpayTouch.supportEmail String No

Support Email
afterpayTouch.supportUrl String Yes

Support Url
googlePay Object No

Google Pay details.
googlePay.reuseMerchantId Boolean No

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

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

Klarna details.
klarna.region String Yes

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

Valid values:

  • "EU"
  • "CH"
  • "AU"
  • "NA"
klarna.disputeEmail String Yes

The email address for disputes.
klarna.autoCapture Boolean No

Indicates the status of Automatic capture. Default value: false.
klarna.supportEmail String Yes

The email address of merchant support.
eftpos_australia Object No

Eftpos Australia details.
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

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

Sepa Direct Debit details.
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"
shopperInteraction String No

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.

Valid values:

  • "contAuth"
  • "pos"
  • "eCommerce"
  • "moto"
storeIds[] Array No

The unique identifier of the store for which to configure the payment method, if any.
customRoutingFlags[] Array No

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

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

EFT PAD details.
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"
interac_card Object No

Interac Card details.
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"
alipayPlus Object No

AlipayPlus details.
alipayPlus.settlementCurrencyCode String No

The currency used for settlement. Defaults to USD.
vipps Object No

Vipps details.
vipps.logo String Yes

Vipps logo. Format: Base64-encoded string.
vipps.subscriptionCancelUrl String No

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

Meal Voucher FR details.
mealVoucher_FR.siret String Yes

Meal Voucher siret. Format: 14 digits.
mealVoucher_FR.conecsId String Yes

Meal Voucher conecsId. Format: digits only
mealVoucher_FR.subTypes[] Array Yes

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

Edenred (Brazil) details.
ticket.requestorId String No

Ticket requestorId
payme Object No

PayMe details.
payme.logo String Yes

Merchant logo. Format: Base64-encoded string.
payme.displayName String Yes

Merchant display name
payme.supportEmail String Yes

The email address of merchant support.
pulse Object No

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

STAR details.
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"
currencies[] Array No

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

Maestro details. 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"
amex Object No

Amex details.
amex.serviceLevel String Yes

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.

Valid values:

  • "paymentDesignatorContract"
  • "noContract"
  • "gatewayContract"
amex.reuseMidNumber Boolean No

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
amex.midNumber String No

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

Girocard details.
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"

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
© 2025 SimWorkflow
Terms of Service Privacy Policy