ADadyen
Payment methods - merchant level

Request a payment method

Changed on

Sends a request to add a new payment method to the merchant account identified in the path. Depending the payment method type, you may need to send an additional object required for the payment method.

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

  • Management API—Payment methods read and write
post/merchants/{merchantId}/paymentMethodSettings

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/merchants/{merchantId}/paymentMethodSettings
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

Request body

businessLineIdstring

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

countriesstring[]

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

currenciesstring[]

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

customRoutingFlagsstring[]

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

referencestring

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

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.

storeIdsstring[]

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

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' | 'ancv' | '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' | 'ebt' | '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' | 'wero' required

Payment method variant.

For payment method variant cartebancaire, method-specific details are returned in the cartesBancaires object of the response.

Response

OK - the request has succeeded.

allowedboolean

Indicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.

businessLineIdstring

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

countriesstring[]

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

currenciesstring[]

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

customRoutingFlagsstring[]

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

enabledboolean

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

idstring required

The identifier of the resource.

merchantCategoryCodestring

The Merchant Category Code (MCC) associated with the payment method.

midstring

The Merchant Identifier (MID) associated with the payment method.

referencestring

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

shopperInteractionstring

The sales channel.

storeIdsstring[]

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

typestring

Payment method variant.

For payment method variant cartebancaire, method-specific details are returned in the cartesBancaires object.

verificationStatus'valid' | 'pending' | 'invalid' | 'rejected'

Payment method status. Possible values:

  • valid
  • pending
  • invalid
  • rejected

Changes

  • v355cb8143ce0eRevision changes
    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new ancv enum value to the request property

    • info

      added the new ebt enum value to the request property

    • info

      added the new wero enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

  • v3f634b6afa653Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      added the new optional request property /

    • info

      added the new cashapp enum value to the request property

    • info

      added the optional property to the response with the status