Get a list of merchant accounts

get/merchants

API Version

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

Endpoint destination URL

https://management-test.adyen.com/v3/merchants

Query Parameters

Required

Optional

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

The number of the page to fetch.

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.
_linksobject
Pagination references.
firstobject
The first page.
hrefstring
lastobject
The last page.
hrefstring
nextobject
The next page. Only present if there is a next page.
hrefstring
prevobject
The previous page. Only present if there is a previous page.
hrefstring
selfobject
The current page.
hrefstring
dataarray[object]
The list of merchant accounts.
_linksobject
References to resources connected with this merchant.
apiCredentialsobject
hrefstring
selfobject
Link to the resource itself.
hrefstring
usersobject
hrefstring
webhooksobject
hrefstring
captureDelaystring
The capture delay set for the merchant account.

Possible values:

Immediate

Manual

Number of days from 1 to 29

companyIdstring
The unique identifier of the company account this merchant belongs to
dataCentersarray[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.
livePrefixstring
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.
namestring
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

defaultShopperInteractionstring
The default shopperInteraction value used when processing payments through this merchant account.
descriptionstring
Your description for the merchant account, maximum 300 characters
idstring
The unique identifier of the merchant account.
merchantCitystring
The city where the legal entity of this merchant account is registered.
namestring
The name of the legal entity associated with the merchant account.
pricingPlanstring
Only applies to merchant accounts managed by Adyen's partners. The name of the pricing plan assigned to the merchant account.
primarySettlementCurrencystring
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.
referencestring
Reference of the merchant account.
shopWebAddressstring
The URL for the ecommerce website used with this merchant account.
statusstring
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.

itemsTotalinteger
Total number of items.
pagesTotalinteger
Total number of pages.
204 - No Content
The request has been successfully processed, but there is no additional content.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of merchant accounts

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error