Sign in
Account - store level

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.

patch/merchants/{merchantId}/stores/{storeId}

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

storeIdstring required

The unique identifier of the store.

Request body

businessLineIdsstring[]

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

descriptionstring

The description of the store.

externalReferenceIdstring
phoneNumberstring

The phone number of the store, including '+' and country code.

status'active' | 'closed' | 'inactive'

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

OK - the request has succeeded.

businessLineIdsstring[]

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.

descriptionstring

The description of the store.

externalReferenceIdstring
idstring

The unique identifier of the store. This value is generated by Adyen.

merchantIdstring

The unique identifier of the merchant account that the store belongs to.

phoneNumberstring

The phone number of the store, including '+' and country code.

referencestring

A 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 (_)

shopperStatementstring

The store name shown on the shopper's bank or credit card statement and on the shopper receipt.

status'active' | 'closed' | 'inactive'

The status of the store. Possible values are:

  • active. This value is assigned automatically when a store is created.
  • inactive. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible.
  • closed. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.

Changes

Changed in 1 of the 50 revisions of this API.1

  • v16ba6f815220c1See the full diff
    • ○

      added the optional property localizedInformation to the response with the 200 status

      response-optional-property-added