Automate store management

The Management API lets you retrieve, create, and update your stores by making API requests. You can also do this manually in your Customer Area, but with API requests you can automate these processes.

For more information about stores and point-of-sale account structures, see Set up your Adyen account for point of sale.

When creating and managing stores using API requests, you need to be aware of:

• How stores are identified.
• The status that a store can have.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

Store identification

Historically, stores under a merchant account have a human-readable reference, also known as the store code. This reference is unique for the merchant account. However, it is possible that a store reference is not unique on our platform. So we introduced a platform-generated unique store ID for each store.

When you create a store, you can provide a reference for it, and Adyen will automatically assign a unique ID.

For existing stores, the situation can vary. We are currently assigning unique IDs to existing stores, but it will take a while before this is completed. This means that if your existing store doesn't have an ID yet, you cannot make a PATCH request to update the store.

Opening and closing stores

Stores can have three statuses that determine how they operate:

• active: when you create a store, it is automatically set to active. After assigning and boarding payment terminals, the store is immediately open for business.

• inactive: when you change the store status from active to inactive, the store is blocked from accepting new transactions, but capturing outstanding transactions is still possible. The maximum transaction limits and number of Store-and-Forward transactions for the store are set to zero (0). When you change the store status back to active, this restriction is removed.

• closed: before you can close a store, you must first change the store status to inactive. Then, when you change the store status from inactive to closed, all payment terminals under the store are immediately reassigned to the merchant inventory. This means the terminals need to be assigned to a different store and boarded before they can process transactions again. It is not possible to change the status anymore because a closed store cannot be reopened.

Retrieve store details

You can make API requests to:

• Get a list of stores. For each store, the response includes the full details.
• Get the details of a specific store.

Get a list of stores

1. To get a list of stores, use one of the following endpoints:

   • GET /stores for the details of all stores that your API key has access to.
   • GET /merchants/{merchantId}/stores for the details of the stores under a specific merchant account. To find the merchantId, make a GET request to /merchants.

   You can filter the paginated response using the following query parameters:

   • pageNumber: returns the stores listed on the specified page.
   • pageSize: the number of stores to have on a page. The default is 10, the maximum is 100.
   • merchantId: the merchant account ID that a store belongs to. You can only use this query parameter with a GET /stores request.
   • reference: the reference of the store. Because a store reference is only unique within a merchant account, a GET /stores request using the store reference as a query parameter returns all stores with that reference, including those of different merchant accounts.

2. In the response, note the id of the store. You can use this value to get the details of a specific store or to update a store.

   The next table shows the store details that the response can include.

   Parameter	Description
   address	An object that contains: city: The city of the store. country: The country of the store. line1 line2 line3: Up to three lines used for the street name, street number, and other information. postalCode: The postal code of the store. stateOrProvince: The state or province code as defined in ISO 3166-2. For example, IL for Illinois in the United States.
   description	The description of the store.
   externalReferenceId	The unique identifier of the store, used by certain payment methods and tax authorities.
   id	Unique identifier of the store, starting with ST. This value is generated by Adyen.
   _links	The URL of the store.
   merchantId	The ID of the merchant account that the store belongs to.
   phoneNumber	The phone number of the store, including the country code.
   reference	The reference for the store. If a reference was not specified when the store was created, the reference is populated with the store id.
   shopperStatement	Store name shown on the shopper's bank or credit card statement and on the shopper receipt.
   splitConfiguration	Only for Adyen for Platforms merchants. An object containing the information required to automatically split transactions that are routed through this store. This object consists of: splitConfigurationId: the unique identifier of the split configuration profile that you want to add to the store. balanceAccountId: The unique identifier of the balance account to which the split amount must be booked, depending on the defined splitLogic.
   status	The status of the store.

Get the details of a specific store

1. Make sure that you know the id or the reference of the store. To find these values, get a list of stores.

2. To get the details of a single store, use the following endpoints:

   • GET /stores/{storeId}
   • GET /merchants/{merchantId}/stores/{storeId}

   You can also use the store reference as a query parameter. Because the reference is only unique within a merchant account, if you use the /stores endpoint you get all stores with that reference, including those of different merchant accounts.

   To get the details of a store under a merchant account using the store reference, make a GET request to /merchants/{merchantId}/stores?reference={reference}.

   This example shows how to get information about a store using the store ID in the path.

3. Note that the response returns the same details as when you get a list of stores, but only for the specified store.

Create a store

Before you create a store, make sure you know the merchant account ID that the store will be associated with.
For a list of merchant account IDs accessible with your API key, make a GET request to /merchants.

1. To create a store, make a POST /stores, specifying:

   Parameter	Required	Description
   address		An object that contains: city: the city of the store. country: the country of the store. line1 line2 line3: up to three lines can be used for the street name, street number, and other information. Only the first line is mandatory. postalCode: the postal code of the store. stateOrProvince: Required for Australia, Brazil, Canada, India, Mexico, New Zealand, United States. The state or province of the store as defined in ISO 3166-2. For example, ON for Ontario, Canada.
   description		A description for the store.
   externalReferenceId		Only when using the Zip payment method. The location ID that Zip has assigned to your store.
   merchantId		The merchant account ID.
   phoneNumber		The complete phone number of the store, beginning with + and the country code.
   reference		A unique reference to recognize the store by. 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		The store name shown on the shopper's bank or credit card statement and the shopper receipt. Maximum length: 22 characters. Cannot be all numerals.
   splitConfiguration		Only for Adyen for Platforms merchants. An object containing the information required to automatically split transactions that are routed through this store. This object consists of: splitConfigurationId: the unique identifier of the split configuration that you want to add to the store. balanceAccountId: The unique identifier of the balance account to which the split amount must be booked, depending on the defined splitLogic.

   You can also make a POST request to /merchants/{merchantId}/stores using the same parameters. In that case you do not need to include the merchant account ID in the request body.

   The following example shows how to create a store:

   2. In the response, note that this includes the Adyen-generated id for the store. You can use this as a path parameter to update the store.

   3. Add payment methods to the store.

   Manage payment methods

   A newly created store doesn't have any payment methods yet. You need to add payment methods one at a time. Every payment method that you add, gets an ID that is unique for the combination of that payment method and store. Using this ID, you can update the settings of that payment method in the corresponding store.

   Add a payment method

   1. To decide what payment method to add:

      • See the list of payment methods that you can add using Management API.

        Some payment methods (like iDEAL) only apply to web shops and are not supported on payment terminals.

      • For a list of payment methods that are already enabled for your store, make a GET request to /merchants/{merchantId}/paymentMethodSettings with your store ID as a query parameter.
        For example, .../paymentMethodSettings?storeID=ST322LJ223223K5F4SQNR9XL5.

   2. To add a payment method to your store, make a POST request to /merchants/{merchantId}/paymentMethodSettings with your store ID in the request body (not as a query parameter). Specify:

      Parameter	Required	Description
      type		Payment method type. Some payment methods require an additional object with payment method details.
      businessLineId		The unique identifier of your user's business line that you want to request a payment method for.
      storeIds		The id of the store that you get when creating a store .
      countries		The list of countries to enable with the payment method. To enable all countries supported by the payment method, set to ANY or send empty.
      currencies		The list of currencies to enable with the payment method. To enable all currencies supported by the payment method, set to ANY or send empty.

      The following example adds American Express.

   3. In the response, note that this includes the id of the payment method. This ID is specific for the combination of payment method and store. You can use this as a path parameter to update the settings of the payment method.

   4. To check if the added payment method is enabled, make a GET request to /merchants/{merchantId}/paymentMethodSettings with your store ID as a query parameter.

   Update a payment method

   After adding a payment method to a store, you can change its settings. For example, to update the supported countries/regions or currencies, or to disable the payment method.

   To update a payment method:

   1. Make sure that you know the id of the payment method for the applicable store. To find this value, make a GET request to /merchants/{merchantId}/paymentMethodSettings.

   2. Make a PATCH request to /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}, specifying:

      Parameter	Required	Description
      countries		The list of countries to enable with the payment method. If sent empty, then all countries are supported by the payment method.
      currencies		The list of currencies to enable with the payment method. If sent empty, then all currencies are supported by the payment method.
      enabled		Indicates whether the payment method is enabled (true) or disabled (false).

      Because the payment method ID in the path is unique for the store where the payment method is set up, there is no need to specify a store.

      The next example updates American Express with payments in Canadian dollars:

   3. In the response, note that this contains the storeId of the store that the payment method was updated for.

   Update a store

   To update a store, you need to know its unique store ID. In your request, include only the parameters you want to update. The same applies if the parameter is inside an object.

   For example, to change the postal code and remove the third address line from the store address, the address object should include the postalCode parameter with the new value, and the line3 parameter with an empty value.

   To update a store:

   1. Make sure that you know the id of the store. To find this value, get a list of stores.

   2. To update the store, use the following endpoints:

      • PATCH /stores/{storeId}
      • PATCH /merchants/{merchantId}/stores/{storeId}

      In the request body, include any of the following parameters:

      Parameter	Description
      address	Can contain string values for the following parameters: city: The city of the store. line1 line2 line3: Up to three lines can be used for the street name, street number, and other information. postalCode: The postal code of the store. Must be in the same postal code format as the country of the store. stateOrProvince: Required for Australia, Brazil, Canada, India, Mexico, New Zealand, United States. The state or province of the store as defined in ISO 3166-2. For example, ON for Ontario, Canada. It is not possible to update the country of the store.
      description	Your description of the store.
      externalReferenceId	Only when using the Zip payment method. The location ID that Zip has assigned to your store.
      splitConfiguration	Only for Adyen for Platforms merchants. An object containing the information required to automatically split transactions that are routed through this store. This object consists of: splitConfigurationId: the unique identifier of the split configuration that you want to add to the store. balanceAccountId: The unique identifier of the balance account to which the split amount must be booked, depending on the defined splitLogic.
      status	The status of the store. You can change the status from active to inactive or from inactive to active or closed. After a store is closed, you cannot change the status anymore.

      This example shows how you update a store's street address and postal code, identifying the store by ID. The first two lines of the address are changed and the third line is removed by including an empty value:

   3. Note that the response includes the full store details.

   See also

   • Order terminals using API requests
   • Assign terminals using API requests
   • Configure terminals using API requests