Get a store
Returns the details of the store identified in the path.
To make this request, your API credential must have one of the following roles:
- Management API—Stores read
- Management API—Stores read and write
Path Parameters
The unique identifier of the store.
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_linksobjectReference to resources connected with the store.
addressobjectThe address of the store.
citystringThe name of the city.
countrystringThe two-letter country code in ISO_3166-1_alpha-2 format.
line1stringThe street address.
line2stringSecond address line.
line3stringThird address line.
postalCodestringThe postal code.
stateOrProvincestringThe 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.
descriptionstringThe description of the store.
externalReferenceIdstringidstringThe unique identifier of the store. This value is generated by Adyen.
merchantIdstringThe unique identifier of the merchant account that the store belongs to.
phoneNumberstringThe phone number of the store, including '+' and country code.
referencestringA 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 (_)
shopperStatementstringThe store name shown on the shopper's bank or credit card statement and on the shopper receipt.
splitConfigurationobjectRules for Adyen for Platforms merchants to split the transaction amount and fees.
balanceAccountIdstringThe unique identifier of the balance account to which the split amount must be booked, depending on the defined split logic.
splitConfigurationIdstringThe unique identifier of the split configuration profile.
statusstringThe 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.
400 - Bad Request
A problem reading or understanding the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]Detailed explanation of each validation error, when applicable.
InvalidFieldobjectmessagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]Detailed explanation of each validation error, when applicable.
InvalidFieldobjectmessagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]Detailed explanation of each validation error, when applicable.
InvalidFieldobjectmessagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]Detailed explanation of each validation error, when applicable.
InvalidFieldobjectmessagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA 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 moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]Detailed explanation of each validation error, when applicable.
InvalidFieldobjectmessagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.