Update a store

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
Endpoint destination URL
https://management-test.adyen.com/v3/merchants/{merchantId}/stores/{storeId}
Click to copy

Path Parameters

storeIdstringRequired

The unique identifier of the store.

merchantIdstringRequired

The unique identifier of the merchant account.

Request Parameters

addressobject

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

businessLineIdsarray[string]

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

descriptionstring

The description of the store.

externalReferenceIdstring

The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.

Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.

Optional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.

phoneNumberstring

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.

splitConfigurationobject

Rules for Adyen for Platforms merchants to split the transaction amount and fees.

statusstring

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 moreShow less
  • 204 - No Content

    The request has been successfully processed, but there is no additional content.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less