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

Path Parameters

merchantIdstringRequired

The unique identifier of the merchant account.

Request Parameters

addressobjectRequired

The address of the store.

businessLineIdsarray[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.

descriptionstringRequired

Your 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.

phoneNumberstringRequired

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.

shopperStatementstringRequired

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.

splitConfigurationobject

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

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