ManagementAccountAccount merchant level
Get a list of merchant accounts
Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.
To make this request, your API credential must have the following roles:
- Management API—Account read
AuthorizationBasic <token>
In: header
Query Parameters
pageNumber?integer
The number of the page to fetch.
Format
int32pageSize?integer
The number of items to have on a page, maximum 100. The default is 10 items on a page.
Format
int32Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/merchants"Example response when your API credential has access to 23 merchant accounts
{ "_links": { "first": { "href": "https://management-test.adyen.com/v1/merchants?pageNumber=1&pageSize=10" }, "last": { "href": "https://management-test.adyen.com/v1/merchants?pageNumber=3&pageSize=10" }, "next": { "href": "https://management-test.adyen.com/v1/merchants?pageNumber=2&pageSize=10" }, "self": { "href": "https://management-test.adyen.com/v1/merchants?pageNumber=1&pageSize=10" } }, "itemsTotal": 23, "pagesTotal": 3, "data": [ { "id": "YOUR_MERCHANT_ACCOUNT_1", "name": "YOUR_MERCHANT_NAME_1", "captureDelay": "immediate", "defaultShopperInteraction": "Ecommerce", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_1", "merchantCity": "Amsterdam", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_2", "name": "YOUR_MERCHANT_NAME_2", "captureDelay": "immediate", "defaultShopperInteraction": "POS", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_2", "merchantCity": "", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_3", "status": "YOUR_MERCHANT_NAME_3", "merchantCity": "Amsterdam", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_4", "name": "YOUR_MERCHANT_NAME_4", "captureDelay": "immediate", "defaultShopperInteraction": "Ecommerce", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_4", "merchantCity": "Sao Paulo", "primarySettlementCurrency": "BRL", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_5", "name": "YOUR_MERCHANT_NAME_5", "captureDelay": "3", "defaultShopperInteraction": "Ecommerce", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_5", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_6", "name": "YOUR_MERCHANT_NAME_6", "captureDelay": "immediate", "defaultShopperInteraction": "Ecommerce", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_6", "merchantCity": "Zagreb", "primarySettlementCurrency": "BRL", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_7", "name": "YOUR_MERCHANT_NAME_7", "captureDelay": "manual", "defaultShopperInteraction": "Moto", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_7", "merchantCity": "Amsterdam", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_8", "name": "YOUR_MERCHANT_NAME_8", "captureDelay": "immediate", "defaultShopperInteraction": "Ecommerce", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_8", "merchantCity": "Amsterdam", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_9", "name": "YOUR_MERCHANT_NAME_9", "captureDelay": "3", "defaultShopperInteraction": "Ecommerce", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_9", "merchantCity": "", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/webhooks" } } }, { "id": "YOUR_MERCHANT_ACCOUNT_10", "name": "YOUR_MERCHANT_NAME_10", "captureDelay": "manual", "defaultShopperInteraction": "Ecommerce", "status": "Active", "shopWebAddress": "YOUR_SHOP_URL_10", "merchantCity": "Paris", "primarySettlementCurrency": "EUR", "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10" }, "apiCredentials": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/apiCredentials" }, "users": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/users" }, "webhooks": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/webhooks" } } } ]}Get a list of merchant accounts GET
Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read
Create a merchant account POST
Creates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write