Get the stores of an account

post/getStoresUnderAccount

API Version

Deprecated in version 1

Returns a list of stores associated with a company account or a merchant account, including the status of each store.

From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management API.

Endpoint destination URL

https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getStoresUnderAccount

Request Parameters

Required

Optional

The company account. If you only specify this parameter, the response includes the stores of all merchant accounts that are associated with the company account.

The merchant account. With this parameter, the response only includes the stores of the specified merchant 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.
storesarray[object]
Array that returns a list of all stores for the specified merchant account, or for all merchant accounts under the company account.
addressobject
The address of the store.
citystring
countryCodestring
postalCodestring
stateOrProvincestring
streetAddressstring
streetAddress2string
descriptionstring
The description of the store.
inStoreTerminalsarray[string]
The list of terminals assigned to the store.
merchantAccountCodestring
The code of the merchant account.
statusstring
The status of the store:

PreActive: the store has been created, but not yet activated.

Active: the store has been activated. This means you can process payments for this store.

Inactive: the store is currently not active.

InactiveWithModifications: the store is currently not active, but payment modifications such as refunds are possible.

Closed: the store has been closed.

storestring
The code of the store.
400 - Bad Request
A problem reading or understanding the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Get the stores of an account

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error