Default icon

Payment methods

Learn how you can configure payment methods in your balance platform integration.

Before you start processing payments for your users, you must configure the payment methods through which they can accept payments. Adyen's payment platform supports most global and local card payment methods with a single technical integration.

Payment methods must be configured separately for each of your users' stores.

Before you begin

Make sure that:

  • The payment method you want to configure is supported.
  • Your Management API credential has the Management API—Payment methods read and write role.

Configure payment methods for a store

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 -white_check_mark- The payment method variant. Some payment methods require additional configuration or parameters. For details, see the Supported payment methods.
businessLineId -white_check_mark- The unique identifier of your user's business line for which you want to request a payment method.
storeIds -white_check_mark- The id of the store that you get when creating a store for your user. For the list of stores in your merchant account, make a GET /merchants/{merchantId}/stores request.
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.

Webhooks

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

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

Payment method status

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:

Parameter Required Description
countries The list of countries to enable with the payment method. If sent empty, then all countries are supported by the payment method.
currencies The list of currencies to enable with the payment method. If sent empty, then all currencies are supported by the payment method.
enabled Indicates whether the payment method is enabled (true) or disabled (false).

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
ACH Direct Debit ach
-white_check_mark-
-x-
Requires approval, reach out to your Adyen contact.
American Express amex
-white_check_mark-
-white_check_mark-
Requires currencies and shopper interaction.
Apple Pay applepay
-white_check_mark-
Requires additional parameters
-white_check_mark-
No configuration required
Bancontact bcmc
-white_check_mark-
-white_check_mark-
Requires additional parameters.
BLIK blik
-white_check_mark-
-x-
Carte Bancaire cartebancaire
-white_check_mark-
-white_check_mark-
Supported only if the store is located in France. Requires additional parameters.
China UnionPay (CUP) cup
-white_check_mark-
-white_check_mark-
Requires shopper interaction.
Diners diners
-white_check_mark-
-white_check_mark-
Discover will be automatically included in the setup. Diners Club International® is part of Discover.
Discover discover
-white_check_mark-
-white_check_mark-
Diners will be automatically included in the setup. Diners Club International® is part of Discover.
eftpos Australia eftpos_australia
-white_check_mark-
-white_check_mark-
Girocard girocard
-x-
-white_check_mark-
Google Pay googlepay
-white_check_mark-
Requires additional parameters
-white_check_mark-
No configuration required
iDEAL ideal
-white_check_mark-
-x-
Interac interac_card
-x-
-white_check_mark-
JCB jcb
-white_check_mark-
-white_check_mark-
Requires shopper interaction and currencies for Australia, Canada, and New Zealand.
Maestro maestro
-white_check_mark-
-white_check_mark-
MB WAY mbway
-white_check_mark-
-x-
Mastercard mc
-white_check_mark-
-white_check_mark-
MobilePay mobilepay
-white_check_mark-
See note 1
-x-
Multibanco multibanco
-white_check_mark-
-x-
Online banking Poland onlinebanking_Pl
-white_check_mark-
-x-
Pay by Bank (Europe) paybybank
-white_check_mark-
-x-
Available currencies: EUR and GBP.
Payshop payshop
-white_check_mark-
-x-
Trustly trustly
-white_check_mark-
-x-
TWINT twint
-white_check_mark-
See note 1
-x-
Requires additional parameters.
twint_pos
-x-
-white_check_mark-
Requires additional parameters.
Vipps vipps
-white_check_mark-
See note 1
-x-
Requires additional parameters.
Visa visa
-white_check_mark-
-white_check_mark-
VPay vpay
-white_check_mark-
-white_check_mark-

1 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.