Create a store
Creates a store for the merchant account identified in the path.
To make this request, your API credential must have the following role:
- Management API—Stores read and write
In the live environment, requests to this endpoint are subject to rate limits.
In: header
Path Parameters
The unique identifier of the merchant account.
Request Body
application/json
The address of the store.
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.
Your description of the store.
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.
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.
Your 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 (_).
If you do not provide a reference in your POST request, it is populated with the Adyen-generated id.
The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers.
Rules for Adyen for Platforms merchants to split the transaction amount and fees.
The sub-merchant data relevant for registered payment facilitators transacting on standalone terminals.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/merchants/string/stores" \ -H "Content-Type: application/json" \ -d '{ "description": "City centre store", "shopperStatement": "Springfield Shop", "phoneNumber": "13123456789", "reference": "Spring_store_2", "address": { "country": "US", "line1": "200 Main Street", "line2": "Building 5A", "line3": "Suite 3", "city": "Springfield", "stateOrProvince": "NY", "postalCode": "20250" } }'Example response after creating a store
{ "id": "YOUR_STORE_ID", "address": { "country": "US", "line1": "200 Main Street", "line2": "Building 5A", "line3": "Suite 3", "city": "Springfield", "stateOrProvince": "NY", "postalCode": "20250" }, "description": "City centre store", "merchantId": "YOUR_MERCHANT_ACCOUNT_ID", "shopperStatement": "Springfield Shop", "phoneNumber": "13123456789", "reference": "Spring_store_2", "status": "active", "_links": { "self": { "href": "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID" } }}Get a list of stores GET
Returns a list of stores for the merchant account identified in the path. 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](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).
Get a store GET
Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).