Get a list of stores

get/stores

Returns a list of stores. The list is grouped into pages as defined by the query parameters.

To make this request, your API credential must have one of the following roles:

Management API—Stores read
Management API—Stores read and write

In the live environment, requests to this endpoint are subject to rate limits.

Endpoint destination URL

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

Query Parameters

Required

Optional

The unique identifier of the merchant account.

The reference of the store.

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]
List of stores
Show children Hide children
_linksobject
Reference to resources connected with the store.
Show children Hide children
selfobject
Link to the resource itself.
Show children Hide children
hrefstring
addressobject
The address of the store.
Show children Hide children
citystring
The name of the city.
countrystring
The two-letter country code in ISO_3166-1_alpha-2 format.
line1string
The street address.
line2string
Second address line.
line3string
Third address line.
postalCodestring
The postal code.
stateOrProvincestring
The state or province code as defined in ISO 3166-2. For example, ON for Ontario, Canada.

Required for the following countries:

Australia

Brazil

Canada

India

Mexico

New Zealand

United States

businessLineIdsarray[string]
The unique identifiers of the business lines that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.
descriptionstring
The description of the store.
externalReferenceIdstring
The unique identifier of the store, used by certain payment methods and tax authorities.

Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by dots, slashes, hyphens, or without separators.

Optional for SIRET in France, up to 14 digits.

Optional for Zip in Australia, up to 50 digits.

idstring
The unique identifier of the store. This value is generated by Adyen.
merchantIdstring
The unique identifier of the merchant account that the store belongs to.
phoneNumberstring
The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.
referencestring
A reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)
shopperStatementstring
The store name shown on the shopper's bank or credit card statement and on the shopper receipt.
splitConfigurationobject
Rules for Adyen for Platforms merchants to split the transaction amount and fees.
Show children Hide children
balanceAccountIdstring
The unique identifier of the balance account to which the split amount must be booked, depending on the defined split logic.
splitConfigurationIdstring
The unique identifier of the split configuration profile.
statusstring
The status of the store. Possible values are:

active. This value is assigned automatically when a store is created.

inactive. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible.

closed. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.

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 stores

Query Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error