Marketplace icon

Manage payment methods through API

Learn how to manage your payment methods for your marketplace using the Management API.

By using the Management API, you can:

  • Get a list of all payment methods configured for your merchant account.
  • Get the details of a payment method.
  • Enable or disable a payment method.
  • Change the country/region or currency of a payment method.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

Requirement Description
Integration type You must have an Adyen online payments integration and a checkout UI.
API credential roles Your Management API credential must have the following role:
  • Management API—Payment methods read and write
Limitations
  • You can only configure payment methods that are supported for your currency and integration.
  • It may take some time for the payment method to become available due to external factors. Payment methods typically appear within a day. To avoid delays, we recommend requesting payment methods at least one day before the business opens.

Get a list of all payment methods

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

Get the details of a specific payment method

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

Update a payment method

To change the settings of a payment method, make a PATCH /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} request with the ID of your merchant account and the payment method in the path.

In the body, you can specify the following parameters:

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

Disabled payment methods are automatically deleted after 90 days.

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 payment method and the updated list of payment method settings.

See also