--- title: "Get all payment methods" method: GET path: "/merchants/{merchantId}/paymentMethodSettings" tags: ["Payment methods - merchant level"] --- # Get all payment methods `GET /merchants/{merchantId}/paymentMethodSettings` Returns details for all payment methods of the merchant account identified in the path. 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 ## Path parameters - `merchantId` string, required ## Query parameters - `storeId` string - `businessLineId` string - `pageSize` integer - `pageNumber` integer ## Response `200` OK - the request has succeeded. - PaymentMethodResponse - `_links` PaginationLinks - `first` LinksElement, required - `href` string - `last` LinksElement, required - `href` string - `next` LinksElement - `href` string - `prev` LinksElement - `href` string - `self` LinksElement, required - `href` string - `data` PaymentMethodWrapper[] — The list of supported payment methods and their details. - `PaymentMethod` 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. - `itemsTotal` integer, required — Total number of items. - `pagesTotal` integer, required — Total number of pages. - `typesWithErrors` string[] — The payment method types that were not successfully requested and their corresponding errors. ## 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)