ADadyen
Account - store level

Create a store

Changed on

Creates a store for the merchant account specified in the request.

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.

post/stores

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/stores
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

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 required

Your description of the store.

externalReferenceIdstring

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.

merchantIdstring required

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

phoneNumberstring required

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.

referencestring

Your 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 (_).

If you do not provide a reference in your POST request, it is populated with the Adyen-generated id.

shopperStatementstring required

The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers.

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

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.

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 in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

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

  • v3cb9770d903d0Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • v37648db985641Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status