Get a list of company accounts

get/companies

Returns the list of company 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/companies

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.
Show moreShow less
_linksobject
Pagination references.
Show children Hide children
firstobject
The first page.
Show children Hide children
hrefstring
lastobject
The last page.
Show children Hide children
hrefstring
nextobject
The next page. Only present if there is a next page.
Show children Hide children
hrefstring
prevobject
The previous page. Only present if there is a previous page.
Show children Hide children
hrefstring
selfobject
The current page.
Show children Hide children
hrefstring
dataarray[object]
The list of companies.
Show children Hide children
_linksobject
References to resources connected with this company.
Show children Hide children
apiCredentialsobject
Show children Hide children
hrefstring
selfobject
Link to the resource itself.
Show children Hide children
hrefstring
usersobject
Show children Hide children
hrefstring
webhooksobject
Show children Hide children
hrefstring
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.
Show children Hide children
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

descriptionstring
Your description for the company account, maximum 300 characters
idstring
The unique identifier of the company account.
namestring
The legal or trading name of the company.
referencestring
Your reference to the account
statusstring
The status of the company account.

Possible values:

Active: Users can log in. Processing and payout capabilities depend on the status of the merchant account.

Inactive: Users can log in. Payment processing and payouts are disabled.

Closed: The company 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.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
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.
Show children Hide children
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.
Show more Show less
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.
Show children Hide children
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.
Show more Show less
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.
Show children Hide children
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.
Show more Show less
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.
Show children Hide children
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.
Show more Show less
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.
Show children Hide children
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 company accounts

Query Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error