Default icon

Manage stores

Learn how to manage stores for your users.

On this page, you can learn how to:

  • Retrieve the details of all stores in your merchant account.
  • Retrieve the details a specific store.
  • Update the details of a store.

Store identification

When you create a store, Adyen automatically assigns a unique ID to the store. You can also optionally provide a store reference for your reports. The store ID is unique to the entire Adyen platform, while the reference is only unique to your merchant account. To update the store, you need to know the store ID.

Retrieve store details

You can make API requests to:

Get a list of stores

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

    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.
    id Unique identifier of the store, starting with ST. This value is generated by Adyen.
    businessLineIds Unique identifiers of the business lines associated with the store.
    _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 An object containing the information required to automatically split transactions that are routed through this store.

    This object consists of:

    status The status of the store.

Get the details of a specific store

  1. Make sure 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:

    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.

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

    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 only for the United States. The state or province of the store as defined in ISO 3166-2. For example, IL for Illinois in the United States.
    It is not possible to update the country of the store.
    description Your description of the store.
    businessLineIds An array that contains unique identifiers of business lines. Must be part of the same legal entity as the merchant account.
    Business lines can only be added, not removed from a store.
    splitConfiguration An object containing the information required to automatically split transactions that are routed through this store.

    This object consists of:

    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 can't 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.

Store status

Stores can have three statuses that determine how they operate:

  • active: when you create a store, it is automatically set to active. The store can then immediately process payments.

  • 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. 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. It is not possible to change the status anymore because a closed store cannot be reopened.

Next steps