> For the complete documentation index, see [llms.txt](https://docs.pagsmile.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pagsmile.com/reference/remittance-api/business/store/query-stores.md).

# Query Stores

Retrieves stores associated with a merchant within a specified time range, with optional filters and pagination.

**Endpoint**

`POST /remittance/store/query-stores`

**Sandbox base URL:** `https://rem-api-sandbox.pagsmile.com`\
**Content-Type:** `application/json; charset=UTF-8`

The request uses the standard [Remittance API request envelope](https://docs.pagsmile.com/remittance-api/common). The fields below describe the decrypted `biz_data` object.

{% hint style="info" %}
**Requirement:** `M` = Mandatory, `O` = Optional, and `C` = Conditional. A conditional field is mandatory only when the condition stated in its description applies.
{% endhint %}

{% hint style="warning" %}
Encrypt `biz_data`, encrypt the AES key into `random_key`, and sign the request according to the Common request specification.
{% endhint %}

**Request body**

**Decrypted `biz_data` fields**

| Field         | Type    | Requirement | Description                                                                                                       |
| ------------- | ------- | ----------- | ----------------------------------------------------------------------------------------------------------------- |
| `merchant_id` | long    | M           | Pagsmile-assigned unique identifier of the merchant.                                                              |
| `store_id`    | long    | O           | Pagsmile-assigned unique identifier of the store associated with the merchant.                                    |
| `name`        | string  | O           | Name used to identify the store in API requests and operational reports.                                          |
| `start_date`  | string  | M           | <p>Start of the query period, inclusive.<br>Format: <code>yyyy-MM-dd HH:</code>​<code>mm:ss</code>.</p>           |
| `end_date`    | string  | M           | <p>End of the query period, inclusive.<br>Format: <code>yyyy-MM-dd HH:</code>​<code>mm:ss</code>.</p>             |
| `page_num`    | integer | O           | <p>One-based page number of the result set.<br>Default: <code>1</code>.</p>                                       |
| `page_size`   | integer | O           | <p>Maximum number of records returned on each page.<br>Default: <code>10</code>.<br>Maximum: <code>30</code>.</p> |

**Plaintext `biz_data` example**

{% hint style="info" %}
This example includes mandatory fields and representative optional or conditional fields. Submit fields marked `C` only when the condition in the field description applies.
{% endhint %}

```json
{
  "merchant_id": 100398,
  "store_id": 100001,
  "name": "Example Name",
  "start_date": "2026-07-20 00:00:00",
  "end_date": "2026-07-20 23:59:59",
  "page_num": 1,
  "page_size": 10
}
```

**Request example**

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/store/query-stores \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'
```

{% hint style="info" %}
Use the `partner_id` and `app_id` assigned to your integration. The values above are placeholders.
{% endhint %}

**Response**

{% tabs %}
{% tab title="Success" %}
The `data` field in the response envelope is AES-encrypted. Decrypt `random_key` with your RSA private key, then use the resulting AES key to decrypt `data`. See [Security](https://docs.pagsmile.com/remittance-api/security) for implementation details.

**Encrypted response example**

```json
{
  "code": "10000",
  "msg": "Success",
  "data": "<AES-encrypted response data>",
  "total": 4,
  "random_key": "<RSA-encrypted AES key>",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}
```

**Decrypted `data` example**

```json
[
  {
    "store_id": 100001,
    "merchant_id": 100398,
    "platform": "walmart",
    "business_type": 20,
    "name": "Example Commerce Store",
    "currencies": [
      "USD",
      "HKD",
      "AUD"
    ],
    "has_store_link": true,
    "store_url": "https://www.example.com",
    "description": "Online store for Example Commerce Ltd."
  }
]
```

{% endtab %}

{% tab title="Invalid signature" %}

```json
{
  "code": "40002",
  "msg": "Business Failed",
  "sub_code": "invalid-signature",
  "sub_msg": "invalid signature"
}
```

{% endtab %}
{% endtabs %}

**Response data fields**

| Field            | Type        | Requirement | Description                                                                                                                                                                           |
| ---------------- | ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `store_id`       | long        | M           | Pagsmile-assigned unique identifier of the store associated with the merchant.                                                                                                        |
| `merchant_id`    | long        | M           | Pagsmile-assigned unique identifier of the merchant associated with the returned record.                                                                                              |
| `platform`       | string      | M           | Platform code associated with the store. See [Platform](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/platform) for supported values.                       |
| `business_type`  | Integer     | M           | <p>Business category that determines the applicable compliance and processing rules.<br>Supported values:<br><code>20</code> — Platform<br><code>21</code> — Independent platform</p> |
| `name`           | string      | M           | Name used to identify the store in API requests and operational reports.                                                                                                              |
| `currencies`     | list        | M           | List of three-letter ISO 4217 codes supported by the store.                                                                                                                           |
| `has_store_link` | boolean     | M           | Indicates whether a public store URL is available.                                                                                                                                    |
| `store_url`      | string      | O           | Public URL of the merchant's store.                                                                                                                                                   |
| `description`    | string(256) | O           | Human-readable description of the store and its intended use.                                                                                                                         |

**Related APIs**

* [Create Store](https://docs.pagsmile.com/remittance-api/business/store/create-store)
* [Update Store](https://docs.pagsmile.com/remittance-api/business/store/update-store)