Are you looking for test card numbers?

Would you like to contact support?

Marketpay icon

Add payment methods

Learn how to add and manage payment methods when using Partner model.

With the partner model setup, payment methods are directly connected to the stores. Use the Management API to add and update payment methods in your users' stores.

Before you begin

This page assumes you've already:

Before you begin, you need to know your:

To get a list of all merchant accounts accessible with your API credentials, make a GET /merchants request.

Add a payment method

To request adding a payment method to your user's store, make a POST /paymentMethodSettings request with your merchant account in the path. In your request, specify:

Parameter Required Description
type -white_check_mark- Payment method variant. Note that some payment methods require an additional object with payment method details.
businessLineId -white_check_mark- The unique identifier of your user's business line that is associated with their storeId.
storeId -white_check_mark- The id of the store that you get when creating a store for your user.
countries The list of countries to enable with the payment method. If sent empty, then all countries supported by the payment method will be enabled.
currencies The list of currencies to enable with the payment method. If sent empty, then all currencies supported by the payment method will be enabled.

Note that some payment methods require additional parameters. Make sure to collect this information from your users before adding the payment method. For more information, see Supported payment methods.

Here's an example of a request to add Visa payments in the Netherlands:

Add a payment method to a store
# Set your X-API-KEY with the API key from the Customer Area.
curl https://management-test.adyen.com/v1/merchants/{merchantId}/paymentMethodSettings \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-X POST \
-d '{
    "type": "visa",
    "businessLineId":"BL322KV223222D5F8H2J4BQ6C",
    "storeId":"ST322LJ223223K5F4SQNR9XL5",
    "currencies": [
        "EUR"
    ],
    "countries": [
        "NL"
    ]
}
'

The response contains the id of the requested payment method.

Response
{
    "id": "PM3227C223224K5DSP4NSDKPK",
    "businessLineId":"BL322KV223222D5F8H2J4BQ6C",
    "storeId": "ST322LJ223223K5F4SQNR9XL5",
    "type": "visa",
    "currencies": [
        "EUR"
    ],
    "countries": [
        "NL"
    ]
}

Adyen reviews and approves your requests to add payment methods. This means that you will receive the outcome of your request asynchronously in a webhook notification.

Update a payment method

To update the settings of a payment method, make a PATCH /paymentMethodSettings/{paymentMethodId} with your merchant account in the path. In your request, 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 with adding payments in the United States:

Update payment method's settings
# Set your X-API-KEY with the API key from the Customer Area.
curl https://management-test.adyen.com/v1/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-X PATCH \
-d '{
    "countries": [
        "NL",
        "US"
    ],
    "currencies": [
        "EUR",
        "USD"
    ]
}
'

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

Response
{
    "id": "PM3227C223224K5DSP4NSDKPK",
    "type": "visa",
    "enabled": true,
    "countries": [
        "NL",
        "US"
    ],
    "currencies": [
        "EUR",
        "USD"
    ]
}

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.

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

Get the settings of a single payment method
# Set your X-API-KEY with the API key from the Customer Area.
curl https://management-test.adyen.com/v1/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-X GET \
-d '{
}
'

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

You can filter the response using the following query parameters:

  • storeId: 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.
Get the settings of all payment methods
# Set your X-API-KEY with the API key from the Customer Area.
curl https://management-test.adyen.com/v1/merchants/{merchantId}/paymentMethodSettings?storeId={storeId}&businessLineId={businessLineId} \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-X GET \
-d '{
}
'

Receive notifications

Adyen sends notifications through webhooks to inform your system about events that occur in the balance platform, such as adding a payment method.

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

Here's an example for adding Visa to your payment methods:

{
  "createdAt": "2022-01-24T14:59:11+01:00",
  "data": {
    "id": "PM3224R223224K5FH4M2K9B86",
    "merchantId": "MERCHANT_ACCOUNT",
    "result": "SUCCESS",
    "storeId": "ST322LJ223223K5F4SQNR9XL5",
    "type": "visa"
  },
  "environment": "test",
  "type": "paymentMethod.created"
}

To configure and accept webhooks from the Balance Platform, see Set up notification webhooks.

Supported payment methods

For a full list of supported payment methods, see Payment methods.