Create a store

post /merchants/{merchantId}/stores

Creates a store for the merchant account identified in the path.

To make this request, your API credential must have the following role:

  • Management API—Stores read and write

Endpoint destination URL{merchantId}/stores
Click to copy

Path parameters

merchantId string Required

The unique identifier of the merchant account.

Request parameters

address object Required

The address of the store.

businessLineIds array [string]

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.

description string Required

Your description of the store.

externalReferenceId string

Used by certain payment methods and tax authorities to uniquely identify the store.

For CNPJ in Brazil, ZIP in Australia and SIRET in France. This field is conditionally required if the store is in Brazil, Australia or France.

For CNPJ the format is 00.000.000/0000-00, can be submitted as just digits, or with dots, slash & hyphen.

For Australian stores ZIP an optional field used by the Zip payment method.

For SIRET the format is 14 digits.

phoneNumber string Required

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

reference string

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.

shopperStatement string 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.

splitConfiguration object

The configuration of the split.

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
  • 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 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