Update a store
Updates the store identified in the path. You can only update some store parameters.
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 store.
Request Body
application/json
The address of the store. It is not possible to update the country of the store.
The unique identifiers of the business lines that the store is associated with.
The 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.
Rules for Adyen for Platforms merchants to split the transaction amount and fees.
The status of the store. Possible values are:
- active: This value is assigned automatically when a store is created.
- inactive: The maximum transaction limits and number of Store-and-Forward transactions for the store are set to 0. This blocks new transactions, but captures are still possible.
- closed: The terminals of the store are reassigned to the merchant inventory, so they can't process payments.
You can change the status from active to inactive, and from inactive to active or closed. Once closed, a store can't be reopened.
Value in
- "active"
- "closed"
- "inactive"
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 PATCH "https://example.com/stores/string" \ -H "Content-Type: application/json" \ -d '{ "address": { "line1": "1776 West Pinewood Avenue", "line2": "Heartland Building", "line3": "", "postalCode": "20251" } }'Example response after updating a store
{ "id": "YOUR_STORE_ID", "address": { "country": "US", "line1": "1776 West Pinewood Avenue", "line2": "Heartland Building", "line3": "", "city": "Springfield", "stateOrProvince": "NY", "postalCode": "20251" }, "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 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).
Get a list of payout settings GET
Returns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read
