Get a list of merchant accounts

get /companies/{companyId}/merchants

Was this page helpful?

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:

Management API—Account read

Endpoint destination URL

https://management-test.adyen.com/v1/companies/{companyId}/merchants

Query parameters

Required Optional

pageSize integer

The number of items to have on a page, maximum 100. The default is 10 items on a page.

pageNumber integer

The number of the page to fetch.

Path parameters

Required Optional

companyId string Required

The unique identifier of the company account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
_links object

Pagination references.

Show children Hide children

first object

The first page.

Show children Hide children

href string

last object

The last page.

Show children Hide children

href string

next object

The next page. Only present if there is a next page.

Show children Hide children

href string

prev object

The previous page. Only present if there is a previous page.

Show children Hide children

href string

self object

The current page.

Show children Hide children

href string

data array [object]

The list of merchant accounts.

Show children Hide children

_links object

References to resources connected with this merchant.

Show children Hide children

apiCredentials object

Show children Hide children

href string

self object

Link to the resource itself.

Show children Hide children

href string

users object

Show children Hide children

href string

webhooks object

Show children Hide children

href string

captureDelay string

The capture delay set for the merchant account.

Possible values:

Immediate

Manual

Number of days from 1 to 29

companyId string

The unique identifier of the company account this merchant belongs to

dataCenters array [object]

List of available data centers.

Adyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers.

Show children Hide children

livePrefix string

The unique live URL prefix for your live endpoint. Each data center has its own live URL prefix.

This field is empty for requests made in the test environment.

name string

The name assigned to a data center, for example EU for the European data center. Possible values are:

default: the European data center. This value is always returned in the test environment.

AU

EU

US

defaultShopperInteraction string

The default shopperInteraction value used when processing payments through this merchant account.

description string

Your description for the merchant account, maximum 300 characters

id string

The unique identifier of the merchant account.

merchantCity string

The city where the legal entity of this merchant account is registered.

name string

The name of the legal entity associated with the merchant account.

pricingPlan string

Only applies to merchant accounts managed by Adyen's partners. The name of the pricing plan assigned to the merchant account.

primarySettlementCurrency string

The currency of the country where the legal entity of this merchant account is registered. Format: ISO currency code. For example, a legal entity based in the United States has USD as the primary settlement currency.

reference string

Reference of the merchant account.

shopWebAddress string

The URL for the ecommerce website used with this merchant account.

status string

The status of the merchant account.

Possible values:

PreActive: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments.

Active: Users can access the merchant account in the Customer Area. If the company account is also Active, then payment processing and payouts are enabled.

InactiveWithModifications: Users can access the merchant account in the Customer Area. You cannot process new payments but you can still modify payments, for example issue refunds. You can still receive payouts.

Inactive: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled.

Closed: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.

itemsTotal integer

Total number of items.

pagesTotal integer

Total number of pages.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity

A request validation error.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error

The server could not process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of merchant accounts

Endpoint destination URL

Query parameters

Path parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error