--- title: "Request a payment method" method: POST path: "/merchants/{merchantId}/paymentMethodSettings" tags: ["Payment methods - merchant level"] --- # Request a payment method `POST /merchants/{merchantId}/paymentMethodSettings` Sends a request to add a new payment method to the merchant account identified in the path. Depending the payment method [`type`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings#request-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](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ## Path parameters - `merchantId` string, required ## Request body - PaymentMethodSetupInfo - `accel` AccelInfo - `processingType` 'billpay' | 'ecom' | 'pos', required — 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**. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `affirm` AffirmInfo - `pricePlan` string — Selected Affirm financing package. Choose from **core**, **standard**, or **signature**. Defaults to **core** if no selection made. - `supportEmail` string, required — Merchant support email used to manage disputes. - `afterpayTouch` AfterpayTouchInfo - `supportEmail` string — Support Email - `supportUrl` string, required — Support Url - `alipayPlus` AlipayPlusInfo - `settlementCurrencyCode` string — The currency used for settlement. Defaults to USD. - `amex` AmexInfo - `midNumber` string — Merchant ID (MID) number. Format: 10 numeric characters. You must provide this field when you request `gatewayContract` or `paymentDesignatorContract` service levels. - `reuseMidNumber` boolean — 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**. - `serviceLevel` 'noContract' | 'gatewayContract' | 'paymentDesignatorContract', required — 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. - `applePay` ApplePayInfo - `domains` string[], required — The list of merchant domains. Maximum: 99 domains per request. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live). - `bcmc` BcmcInfo - `enableBcmcMobile` boolean — Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled. - `businessLineId` string — The unique identifier of the business line. Required if you are a [platform model](https://docs.adyen.com/platforms). - `carnet` CarnetInfo - `addMccAcronym` boolean — Indicates whether to add the MCC acronym to the merchant name for Prosa acquirer in Mexico. When set to **true**, the MCC acronym is automatically appended to the merchant name. Default: **false**. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `cartesBancaires` CartesBancairesInfo - `siret` string, required — Cartes Bancaires SIRET. Format: 14 digits. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `clearpay` ClearpayInfo - `supportUrl` string, required — Support Url - `countries` string[] — The list of countries where a payment method is available. By default, all countries supported by the payment method. - `cup` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `currencies` string[] — The list of currencies that a payment method supports. By default, all currencies supported by the payment method. - `customRoutingFlags` string[] — The list of custom routing flags to route payment to the intended acquirer. - `diners` DinersInfo - `midNumber` string — MID (Merchant ID) number. Required for merchants operating in Japan. Format: 14 numeric characters. - `reuseMidNumber` boolean, required — 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**. - `serviceLevel` 'noContract' | 'gatewayContract' — 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. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `discover` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `eft_directdebit_CA` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `eftpos_australia` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `girocard` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `givex` GivexInfo - `currencyCode` string, required — The three-character ISO currency code, such as **EUR**. - `password` string, required — The password provided by the acquirer. - `paymentFlow` 'Ecommerce' | 'POS', required — The sales channel used for the payment. - `username` string, required — The username provided by the acquirer. - `googlePay` GooglePayInfo - `merchantId` string, required — Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). Character length and limitations: 16 alphanumeric characters or 20 numeric characters. - `reuseMerchantId` boolean — Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: **false**. - `ideal` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `interac_card` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `jcb` JCBInfo - `midNumber` string — 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. - `reuseMidNumber` boolean — 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**. - `serviceLevel` 'noContract' | 'gatewayContract' | 'paymentDesignatorContract' — 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. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `klarna` KlarnaInfo - `autoCapture` boolean — Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). Default value: **false**. - `disputeEmail` string, required — The email address for disputes. - `region` 'NA' | 'EU' | 'CH' | 'AU', required — The region of operation. For example, **NA**, **EU**, **CH**, **AU**. - `supportEmail` string, required — The email address of merchant support. - `maestro` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `maestro_usa` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `mc` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `mealVoucher_FR` MealVoucherFRInfo - `conecsId` string, required — Meal Voucher conecsId. Format: digits only - `siret` string, required — Meal Voucher siret. Format: 14 digits. - `subTypes` string[], required — The list of additional payment methods. Allowed values: **mealVoucher_FR_endenred**, **mealVoucher_FR_groupeup**, **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**. - `nyce` NyceInfo - `processingType` 'billpay' | 'ecom' | 'pos', required — 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**. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `paybybank_plaid` PayByBankPlaidInfo - `logo` string — Merchant logo (max. size 150kB). Format: Base64-encoded string. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `payme` PayMeInfo - `displayName` string, required — Merchant display name - `logo` string, required — Merchant logo. Format: Base64-encoded string. - `supportEmail` string, required — The email address of merchant support. - `paypal` PayPalInfo - `directCapture` boolean — Indicates if direct (immediate) capture for PayPal is enabled. If set to **true**, this setting overrides the [capture](https://docs.adyen.com/online-payments/capture) settings of your merchant account. Default value: **true**. - `payerId` string, required — PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters. - `subject` string, required — Your business email address. - `payto` PayToInfo - `merchantName` string, required — Merchant name displayed to the shopper in the Agreements - `payToPurpose` string, required — 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 - `pulse` PulseInfo - `processingType` 'billpay' | 'ecom' | 'pos', required — 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**. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `reference` string — Your reference for the payment method. Supported characters a-z, A-Z, 0-9. - `sepadirectdebit` SepaDirectDebitInfo - `creditorId` string — Creditor id - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `shopperInteraction` 'eCommerce' | 'pos' | 'moto' | 'contAuth' — The sales channel. Required if: - The merchant account does not have a sales channel. - `type` is **alipay**. When you provide this field, it overrides the default sales channel set on the merchant account. Possible values: **eCommerce**, **pos**, **contAuth**, and **moto**. - `sodexo` SodexoInfo - `merchantContactPhone` string, required — Sodexo merchantContactPhone - `sofort` SofortInfo - `currencyCode` string, required — Sofort currency code. For example, **EUR**. - `logo` string, required — Sofort logo. Format: Base64-encoded string. - `star` StarInfo - `processingType` 'billpay' | 'ecom' | 'pos', required — 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**. - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `storeId` string — The ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/stores__resParam_id), if any. - `svs` SvsInfo - `authorisationMid` string, required — The merchant ID (MID) that the acquirer recognizes you by. - `currencyCode` string, required — The three-character ISO currency code, example **USD** - `swish` SwishInfo - `swishNumber` string, required — Swish number. Format: 10 digits without spaces. For example, **1231111111**. - `ticket` TicketInfo - `requestorId` string — Ticket requestorId - `twint` TwintInfo - `logo` string, required — Twint logo. Format: Base64-encoded string. - `type` 'abrapetite' | 'abrapetite_credit' | 'abrapetite_debit' | 'abrapetite_prepaid' | 'accel' | 'ach' | 'affirm' | 'afterpaytouch' | 'alelo' | 'alipay' | 'alipay_hk' | 'alipay_plus' | 'alipay_plus_alipay_cn' | 'alipay_plus_alipay_hk' | 'alipay_plus_dana' | 'alipay_plus_gcash' | 'alipay_plus_kakaopay' | 'alipay_plus_kplus' | 'alipay_plus_naverpay' | 'alipay_plus_rabbitlinepay' | 'alipay_plus_tosspay' | 'alipay_plus_touchngo' | 'alipay_plus_truemoney' | 'alipay_wap' | 'amex' | 'applepay' | 'avancard' | 'avancard_credit' | 'avancard_debit' | 'banese_card' | 'banese_card_credit' | 'banese_card_debit' | 'banese_card_prepaid' | 'bcmc' | 'blik' | 'blik_pos' | 'br_schemes' | 'carnet' | 'cartebancaire' | 'cashapp' | 'clearpay' | 'clicktopay' | 'cooper' | 'cooper_credit' | 'cooper_debit' | 'cooper_food_debit' | 'cooper_meal_debit' | 'cooper_prepaid' | 'cooper_private_credit' | 'cooper_retail_credit' | 'credtodos' | 'credtodos_private_credit' | 'credtodos_private_debit' | 'cup' | 'diners' | 'directdebit_GB' | 'discover' | 'ebanking_FI' | 'eft_directdebit_CA' | 'eftpos_australia' | 'elo' | 'elocredit' | 'elodebit' | 'girocard' | 'givex' | 'googlepay' | 'green_card' | 'green_card_credit' | 'green_card_debit' | 'green_card_food_prepaid' | 'green_card_meal_prepaid' | 'green_card_prepaid' | 'hiper' | 'hipercard' | 'ideal' | 'interac_card' | 'jcb' | 'klarna' | 'klarna_account' | 'klarna_b2b' | 'klarna_paynow' | 'le_card' | 'le_card_credit' | 'le_card_debit' | 'maestro' | 'maestro_usa' | 'maxifrota' | 'maxifrota_prepaid' | 'mbway' | 'mc' | 'mcdebit' | 'mealVoucher_FR' | 'megaleve' | 'megaleve_credit' | 'megaleve_debit' | 'mobilepay' | 'multibanco' | 'nutricash' | 'nutricash_prepaid' | 'nyce' | 'onlineBanking_PL' | 'paybybank' | 'paybybank_plaid' | 'payme' | 'payme_pos' | 'paynow' | 'paynow_pos' | 'paypal' | 'payto' | 'personal_card' | 'personal_card_credit' | 'personal_card_debit' | 'pulse' | 'romcard' | 'romcard_credit' | 'romcard_debit' | 'senff' | 'senff_credit' | 'sepadirectdebit' | 'sodexo' | 'star' | 'svs' | 'swish' | 'ticket' | 'todo_giftcard' | 'trustly' | 'twint' | 'twint_pos' | 'up_brazil' | 'up_brazil_credit' | 'up_brazil_debit' | 'up_brazil_prepaid' | 'vale_refeicao' | 'vale_refeicao_prepaid' | 'valuelink' | 'vegas_card' | 'vegas_card_credit' | 'vegas_card_debit' | 'vero_card' | 'vero_card_credit' | 'vero_card_debit' | 'vero_card_prepaid' | 'vipps' | 'visa' | 'visadebit' | 'vpay' | 'wechatpay' | 'wechatpay_pos', required — Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). - `valuelink` ValuelinkInfo - `authorisationMid` string, required — Authorisation Mid - `pinSupport` 'PIN' | 'NO PIN', required — PIN Support. For ecommerce, PIN is required. - `submitterId` string — Submitter ID - `terminalId` string — Terminal ID - `vipps` VippsInfo - `logo` string, required — Vipps logo. Format: Base64-encoded string. - `subscriptionCancelUrl` string — Vipps subscription cancel url (required in case of [recurring payments](https://docs.adyen.com/online-payments/tokenization)) - `visa` GenericPmWithTdiInfo - `transactionDescription` TransactionDescriptionInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `wechatpay` WeChatPayInfo - `contactPersonName` string, required — The name of the contact person from merchant support. - `email` string, required — The email address of merchant support. - `wechatpay_pos` WeChatPayPosInfo - `contactPersonName` string, required — The name of the contact person from merchant support. - `email` string, required — The email address of merchant support. ## Response `200` OK - the request has succeeded. - PaymentMethod - `accel` AccelResponseInfo - `processingType` 'billpay' | 'ecom' | 'pos' — 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**. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `affirm` AffirmResponseInfo - `publicApiKey` string — Affirm public API key - `afterpayTouch` AfterpayTouchResponseInfo - `supportEmail` string — Support Email - `supportUrl` string — Support Url - `alipayPlus` AlipayPlusResponseInfo - `settlementCurrencyCode` string — The currency used for settlement. - `allowed` boolean — Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account. - `amex` AmexResponseInfo - `midNumber` string — Merchant ID (MID) number. - `reuseMidNumber` boolean — Indicates whether the Amex Merchant ID is reused from a previously setup Amex payment method. - `serviceLevel` string — 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. - `applePay` ApplePayResponseInfo - `domains` string[] — The list of merchant domains. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live). - `associatedPaymentMethods` AssociatedPaymentMethodWrapper[] — Payment methods that were also updated as part of an associated transition. - `AssociatedPaymentMethod` AssociatedPaymentMethod - `enabled` boolean, required — Indicates whether the payment method is enabled (**true**) or disabled (**false**). - `id` string, required — The identifier of the payment method. - `type` string, required — Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). - `bcmc` BcmcResponseInfo - `enableBcmcMobile` boolean — Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `businessLineId` string — The unique identifier of the business line. Required if you are a [platform model](https://docs.adyen.com/platforms). - `carnet` CarnetResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `cartesBancaires` CartesBancairesResponseInfo - `siret` string — Cartes Bancaires SIRET. Format: 14 digits. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `clearpay` ClearpayResponseInfo - `supportUrl` string — Support Url - `countries` string[] — The list of countries where a payment method is available. By default, all countries supported by the payment method. - `cup` CupResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `currencies` string[] — The list of currencies that a payment method supports. By default, all currencies supported by the payment method. - `customRoutingFlags` string[] — The list of custom routing flags to route payment to the intended acquirer. - `diners` DinersResponseInfo - `midNumber` string — MID (Merchant ID) number. - `reuseMidNumber` boolean — Indicates whether the JCB Merchant ID is reused from a previously configured JCB payment method. - `serviceLevel` string — The service level (settlement type) of this payment method. 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. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `discover` DiscoverResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `eft_directdebit_CA` EFTDirectDebitCAResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `eftpos_australia` EftPosAustraliaResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `enabled` boolean — Indicates whether the payment method is enabled (**true**) or disabled (**false**). - `girocard` GirocardResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `givex` GivexResponseInfo - `currencyCode` string — The three-character ISO currency code - `password` string — The password provided by the acquirer. - `paymentFlow` string — The sales channel used for the payment. - `username` string — The username provided by the acquirer. - `googlePay` GooglePayResponseInfo - `merchantId` string — Google Pay [Merchant ID] - `reuseMerchantId` boolean — Indicates whether the Google Pay Merchant ID is used for several merchant accounts. - `id` string, required — The identifier of the resource. - `ideal` IdealResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `interac_card` InteracCardResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `jcb` JCBResponseInfo - `midNumber` string — MID (Merchant ID) number. - `reuseMidNumber` boolean — Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. - `serviceLevel` string — Specifies the service level (settlement type) of this payment method. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `klarna` KlarnaResponseInfo - `autoCapture` boolean — Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). - `disputeEmail` string — The email address for disputes. - `region` 'AU' | 'CH' | 'EU' | 'NA' — The region of operation. - `supportEmail` string — The email address of merchant support. - `maestro` MaestroResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `maestro_usa` MaestroUSAResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `mc` MCResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `mealVoucher_FR` MealVoucherFRResponseInfo - `conecsId` string — Meal Voucher conecsId. - `siret` string — Meal Voucher siret. - `subTypes` string[] — The list of additional payment methods. - `nyce` NyceResponseInfo - `processingType` 'billpay' | 'ecom' | 'pos' — 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**. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `paybybank_plaid` PayByBankPlaidResponseInfo - `logo` string — Merchant logo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `payme` PayMeResponseInfo - `displayName` string — Merchant display name - `logo` string — Merchant logo. Format: Base64-encoded string. - `supportEmail` string — The email address of merchant support. - `paypal` PayPalResponseInfo - `directCapture` boolean — Indicates if direct (immediate) capture for PayPal is enabled. If set to **true**, this setting overrides the [capture](https://docs.adyen.com/online-payments/capture) settings of your merchant account. Default value: **true**. - `payerId` string — PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters. - `subject` string — Your business email address. - `payto` PayToResponseInfo - `merchantName` string — Merchant name displayed to the shopper in the Agreements - `payToPurpose` string — 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 - `pulse` PulseResponseInfo - `processingType` 'billpay' | 'ecom' | 'pos' — 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**. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `reference` string — Your reference for the payment method. Supported characters a-z, A-Z, 0-9. - `sepadirectdebit` SepaDirectDebitResponseInfo - `creditorId` string — Creditor id - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `shopperInteraction` string — The sales channel. - `sodexo` SodexoResponseInfo - `merchantContactPhone` string — Sodexo merchantContactPhone - `sofort` SofortResponseInfo - `currencyCode` string — Sofort currency code. For example, **EUR**. - `logo` string — Sofort logo. Format: Base64-encoded string. - `star` StarResponseInfo - `processingType` 'billpay' | 'ecom' | 'pos' — 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**. - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `storeId` string — The ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/stores__resParam_id), if any. - `svs` SvsResponseInfo - `authorisationMid` string — The merchant ID (MID) that the acquirer recognizes you by. - `currencyCode` string — The three-character ISO currency code, example **USD** - `swish` SwishResponseInfo - `swishNumber` string — Swish number. Format: 10 digits without spaces. For example, **1231111111**. - `ticket` TicketResponseInfo - `requestorId` string — Ticket requestorId - `twint` TwintResponseInfo - `logo` string — Twint logo. Format: Base64-encoded string. - `type` string — Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). - `valuelink` ValuelinkResponseInfo - `authorisationMid` string — Authorisation Mid - `pinSupport` 'PIN' | 'NO PIN' — PIN Support. For ecommerce, PIN is required. - `submitterId` string — Submitter ID - `terminalId` string — Terminal ID - `verificationStatus` 'valid' | 'pending' | 'invalid' | 'rejected' — Payment method status. Possible values: * **valid** * **pending** * **invalid** * **rejected** - `vipps` VippsResponseInfo - `logo` string — Vipps logo. Format: Base64-encoded string. - `subscriptionCancelUrl` string — Vipps subscription cancel url (required in case of [recurring payments](https://docs.adyen.com/online-payments/tokenization)) - `visa` VisaResponseInfo - `transactionDescription` TransactionDescriptionResponseInfo - `doingBusinessAsName` string — 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 **. , ' _ - ? + * /**. - `type` 'append' | 'dynamic' | 'fixed' — 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) 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](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. - `wechatpay` WeChatPayResponseInfo - `contactPersonName` string — The name of the contact person from merchant support. - `email` string — The email address of merchant support. - `wechatpay_pos` WeChatPayPosResponseInfo - `contactPersonName` string — The name of the contact person from merchant support. - `email` string — The email address of merchant support. ## Other responses - `204` — No Content - the request has been successfully processed, but there is no additional content. - `400` — Bad Request - a problem reading or understanding the request. - `401` — Unauthorized - authentication required. - `403` — Forbidden - insufficient permissions to process the request. - `422` — Unprocessable Entity - a request validation error. - `429` - `500` — Internal Server Error - the server could not process the request. --- [API](https://skmtc.net/adyen/apis/management-api.md) · [All operations](https://skmtc.net/adyen/apis/management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/management-api/versions/1089ade06e17/schema)