Activate merchant account

If you onboarded your users through Adyen's hosted onboarding page or chose the custom onboarding option, you must configure the created merchant accounts.

Step 1: Configure payment methods

For the initial setup or when your users want to offer a new payment method to their customers, they must contact you to add that payment method to their merchant account.

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

Parameter	Required	Description
type		Payment method . Some payment methods require an additional object with payment method details.
businessLineId		The unique identifier of your user's business line that you want to request a payment method for.
storeId		The id of the store that you get when creating a store.
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.

After a payment method is successfully added to the merchant account, you will receive a paymentMethod.created notification.

The following example shows the notification you receive after adding visa payment method to a merchant account.

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

Step 2 (Optional): Get the bank account details

If you collected your user's information through the hosted onboarding page, you must send an API request to query the ID of their transfer instrument. The transfer instrument resource is created automatically when your user enters their bank account details. You will need this ID to enable payouts for your user.

To get the ID of the transfer instrument, send a GET /legalEntities/{id} request, specifying the ID of the main legal entity in the path.

The response contains the transferInstruments.id resource.

{
    "capabilities": {
        "receivePayments": {
            "allowed": true,
            "requested": true,
            "verificationStatus": "valid"
        },
        "sendToTransferInstrument": {
            "allowed": true,
            "requested": true,
            "verificationStatus": "valid"
        }
    },
    "entityAssociations": [
        {
            "associatorId": "LE00000000000000000000001",
            "entityType": "soleProprietorship",
            "legalEntityId": "LE00000000000000000000002",
            "name": "Sole Proprietorship",
            "type": "soleProprietorship"
        }
    ],
    "individual": {
        "email": "s.eller@test.com",
        "phone": {
            "number": "+4912345678901",
            "type": "mobile"
        },
        "birthData": {
            "dateOfBirth": "1991-02-17"
        },
        "identificationData": {
            "nationalIdExempt": true
        },
        "name": {
            "firstName": "Shelly",
            "lastName": "Eller"
        },
        "residentialAddress": {
            "city": "Berlin",
            "country": "DE",
            "postalCode": "10407",
            "street": "Berliner Strasse 1"
        }
    },
    "type": "individual",
    "id": "LE00000000000000000000001",
    "transferInstruments": [
        {
            "id": "SE00000000000000000000001",
            "accountIdentifier": "NL**INGB******7557"
        }
    ]
}

Step 3: Enable payouts

To enable payouts for your user, make a /merchants/{merchantId}/payoutSettings call with the merchant account's ID in the path, and specifying the following in the body of the request:

Parameter	Required	Description
enabled		Set to true.
enabledFromDate		The date when Adyen starts paying out to this bank account.
transferInstrumentId		The unique identifier of the transfer instrument that contains the details of the bank account.

curl https://management-test.adyen.com/v1/merchants/MC3224X22322535GNSDF583XJ/payoutSettings \
-H "Content-Type: application/json" \
-H "x-API-key: YOUR_API_KEY" \
-X POST \
-d '{
    "transferInstrumentId":"SE00000000000000000000001",
    "enabled":true
}'

Step 4: Activate merchant account

To activate your user's merchant account, make a POST /merchants/{merchantId}/activate call, specifying the merchant account's ID in the path.

After the merchant account is activated, your user can start processing payments and receive payouts to their specified bank account.