APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementPayment 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, 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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

Request Body

application/json

accel?

Details to provide if type is accel.

affirm?
afterpayTouch?

Details to provide if type is afterpaytouch.

alipayPlus?

Details to provide if type is alipay_plus.

amex?

Details to provide if type is amex.

applePay?

Details to provide if type is applepay.

bcmc?

Details to provide if type is bcmc (Bancontact).

businessLineId?string

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

cartesBancaires?

Details to provide if type is cartebancaire.

clearpay?

Details to provide if type is clearpay.

countries?array<string>

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

cup?
currencies?array<string>

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

customRoutingFlags?array<string>

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

diners?

Details to provide if type is diners. For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include JCB-specific fields in this object.

discover?
eft_directdebit_CA?
eftpos_australia?
girocard?
givex?

Details to provide if type is givex.

googlePay?

Details to provide if type is googlepay.

ideal?
interac_card?
jcb?

Details to provide if type is jcb. For merchants operating in Japan, midNumber, reuseMidNumber, and serviceLevel fields are required. For merchants operating outside of Japan, these fields are not required.

klarna?

Details to provide if type is klarna or its variant.

You can use the following payment method type values for Klarna:

  • klarna: Klarna Pay Later
  • klarna_account: Klarna Pay over time
  • klarna_paynow: Klarna Pay now
  • klarna_b2b: Billie via Klarna
maestro?
maestro_usa?
mc?
mealVoucher_FR?

Details to provide if type is mealVoucher_FR.

nyce?

Details to provide if type is nyce.

paybybank_plaid?

Details to provide if type is paybybank_plaid.

payme?

Details to provide if type is payme.

paypal?

Details to provide if type is paypal.

payto?

Details to provide if type is payto.

pulse?

Details to provide if type is pulse.

reference?string

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

Lengthlength <= 150
sepadirectdebit?

Details to provide if type is sepadirectdebit.

shopperInteraction?string

The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account.

Possible values: eCommerce, pos, contAuth, and moto.

Value in

  • "eCommerce"
  • "pos"
  • "moto"
  • "contAuth"
sodexo?
sofort?
Deprecated
star?

Details to provide if type is star.

storeIds?array<string>

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

svs?

Details to provide if type is svs.

swish?

Details to provide if type is swish.

  • This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).
  • If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.
ticket?

Details to provide if type is ticket (Edenred Brazil).

twint?

Details to provide if type is twint.

type*string

Payment method variant.

Value in

  • "abrapetite"
  • "abrapetite_credit"
  • "abrapetite_debit"
  • "abrapetite_prepaid"
  • "accel"
  • "ach"
  • "affirm"
  • "afterpaytouch"
  • "alelo"
  • "alipay"
  • "alipay_hk"
  • "alipay_plus"
  • "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"
  • "cartebancaire"
  • "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"
valuelink?

Details to provide if type is valuelink.

vipps?

Details to provide if type is vipps.

visa?
wechatpay?

Details to provide if type is wechatpay.

wechatpay_pos?

Details to provide if type is wechatpay_pos.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/merchants/string/paymentMethodSettings" \  -H "Content-Type: application/json" \  -d '{    "type": "visa",    "currencies": [      "USD"    ],    "countries": [      "US"    ]  }'

Example response after sending a request to add a payment method

{  "id": "PM3227C223224K5FH84M8CBNH",  "type": "visa",  "countries": [    "US"  ],  "currencies": [    "USD"  ]}

Get all payment methods GET

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

Get payment method details GET

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