Payment methods

During the onboarding process, you need to add payment methods to your users' stores. This page explains how you can add additional payment methods and update the settings of existing methods.

Request additional payment methods

To add a payment method to your user's store, make a POST /merchants/{merchantId}/paymentMethodSettings request, specifying the following parameters:

Parameter	Required	Description
type		The payment method variant. Some payment methods require additional configuration or parameters. For details, see the Supported payment methods.
storeIds		The id of your user's store. For the list of stores in your merchant account, make a GET /merchants/{merchantId}/stores request.
businessLineId		The unique identifier of your user's business line for which you want to request a payment method.
countries		The list of countries to enable with the payment method. To enable all countries supported by the payment method, set to ANY or send empty.
currencies		The list of currencies to enable with the payment method. To enable all currencies supported by the payment method, set to ANY or send empty.

Here is an example of a request to accept Visa payments from cards issued in the Netherlands:

The response contains the id of the requested payment method.

After a payment method is configured for your user's store, they can start accepting all of its payment method variants by default. For example, if you configure visa, they can accept all of its variants, including visadebit, visapremiumcredit, visasignature and so on.

Webhooks

Because adding a payment method to your user's store is an asynchronous process, we recommend that you subscribe to the Management webhooks in your Customer Area.

After the payment method has been added to your store, Adyen sends a paymentMethod.created webhook.

Here is an example of the webhook you receive after adding Visa to your payment methods:

Check account holder status

By default, every payment method you request is enabled for your user's store. However, only verified account holders can use the configured payment methods. This means that the account holder must have the following parameters and values set for the receivePayments capability:

If you update you user's legal entity or account holder information after it has been verified, the payment methods may be disabled until the account holder is verified again.

To check the status of your account holder's receivePayments capability, you can either send a GET /accountHolders/{id} request, or listen to the balancePlatform.accountHolder.updated webhook.

Update a payment method

To update the settings of a payment method, make a PATCH /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} request with your merchant account in the path. In the body, specify:

Here's an example of requesting to update Visa payment method by adding support for cards issued in the United States:

The response contains the id of the requested payment method and the updated list of payment method settings.

Get payment method details

You can get the details of a single payment method available on the merchant account or all payment methods available on the merchant account, store, and business line.

Get the details of a specific payment method

To get the details of a single payment method available on the merchant account, make a GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} request with your merchant account and the payment method ID in the path.

Get the details of all payment methods

To get the details of all payment methods available on the merchant account, make a GET /merchants/{merchantId}/paymentMethodSettings request with your merchant account in the path.

You can filter the response using the following query parameters:

• storeIds: The unique identifier of the store for which to return the payment methods.
• businessLineId: The unique identifier of the business line for which to return the payment methods.

Supported payment methods

Payment method	Payment method variant	Ecommerce	Point of sale	Notes
Accel	accel			Requires additional parameters.
ACH Direct Debit	ach			Requires approval, reach out to your Adyen contact.
American Express	amex			Requires currencies and shopper interaction.
Apple Pay	applepay	Requires additional parameters	No configuration required
Bancontact	bcmc			Requires additional parameters.
BLIK	blik
Carte Bancaire	cartebancaire			Supported only if the store is located in France. Requires additional parameters.
China UnionPay (CUP)	cup			Requires shopper interaction.
Diners	diners			Discover will be automatically included in the setup. Diners Club International® is part of Discover.
Discover	discover			Diners will be automatically included in the setup. Diners Club International® is part of Discover.
eftpos Australia	eftpos_australia
Girocard	girocard
Google Pay	googlepay	Requires additional parameters	No configuration required
iDEAL	ideal
Interac	interac_card
JCB	jcb			Requires shopper interaction and currencies for Australia, Canada, and New Zealand.
Klarna	klarna	See note 1		Requires additional parameters.
	klarna_account	See note 1		Requires additional parameters.
	klarna_paynow	See note 1		Requires additional parameters.
Maestro	maestro			Not supported for the US. You can use Maestro USA instead.
MB WAY	mbway
Mastercard	mc
MobilePay	mobilepay	See note 1
Multibanco	multibanco
NYCE	nyce			Requires additional parameters.
Online banking Finland	ebanking_fi
Online banking Poland	onlinebanking_Pl
Pay by Bank (Europe)	paybybank			Available currencies: EUR and GBP.
Payshop	payshop
Trustly	trustly
TWINT	twint	See note 1		Requires additional parameters.
	twint_pos			Requires additional parameters.
Vipps	vipps	See note 1		Requires additional parameters.
Visa	visa
VPay	vpay

¹ This payment method does not support aggregated acquiring accounts for payment facilitators. This means that you must create business lines and stores in your merchant account for the users that want to accept it.