PATCH /merchants/{merchantId}/stores/{storeId}

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

Servers

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

Path parameters

Name	Type	Required	Description
`storeId`	String	Yes	The unique identifier of the store.
`merchantId`	String	Yes	The unique identifier of the merchant account.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`businessLineIds[]`	Array	No	The unique identifiers of the business lines that the store is associated with.
`splitConfiguration`	Object	No	Rules for Adyen for Platforms merchants to split the transaction amount and fees.
`splitConfiguration.splitConfigurationId`	String	No	The unique identifier of the split configuration profile.
`splitConfiguration.balanceAccountId`	String	No	The unique identifier of the balance account to which the split amount must be booked, depending on the defined split logic.
`description`	String	No	The description of the store.
`phoneNumber`	String	No	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.
`status`	String	No	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. Possible values: `"inactive"` `"active"` `"closed"`
`externalReferenceId`	String	No	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.
`address`	Object	No	The address of the store. It is not possible to update the country of the store.
`address.line2`	String	No	Second address line.
`address.line1`	String	No	The street address.
`address.postalCode`	String	No	The postal code.
`address.line3`	String	No	Third address line.
`address.stateOrProvince`	String	No	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
`address.city`	String	No	The name of the city.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.