Update a store

patch /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

Endpoint destination URL

Click to copy

Path parameters

storeId string Required

The unique identifier of the store.

Request parameters

address object

The address of the store. It is not possible to update the country of the store.

businessLineIds array [string]

The unique identifiers of the business lines that the store is associated with.

description string

The description of the store.

externalReferenceId string

When using the Zip payment method: The location ID that Zip has assigned to your store.

splitConfiguration object

Rules for Adyen for Platform merchants to split commission fees.

status string

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.

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 more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy