> 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/onboarding/query-shops.md).

# Query Shops

Retrieves shops associated with a merchant, with optional filters and pagination.

#### Endpoint

`POST /remittance/merchant/query-shops`

**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 on whose behalf the request is submitted. |

**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
}
```

#### Request example

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/merchant/query-shops \
  --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" %}

```json
{
  "code": "10000",
  "msg": "Success",
  "data": [
    {
      "shop_id": 100000,
      "name": "sss",
      "type": 1,
      "shop_url": "www.ssq.com",
      "description": "Jones"
    },
    {
      "shop_id": 100001,
      "name": "ssss",
      "type": 1,
      "shop_url": "www.ssq.com",
      "description": "Johnson"
    }
  ],
  "random_key": "abssdddd2wdw==",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}
```

{% 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                                                                                                    |
| ------------- | ------- | ----------- | -------------------------------------------------------------------------------------------------------------- |
| `shop_id`     | long    | M           | Unique identifier of the shop associated with the merchant.                                                    |
| `name`        | string  | M           | Name used to identify the shop in API requests and operational reports.                                        |
| `type`        | integer | M           | <p>Shop identifier type.<br>Supported values:<br><code>1</code> — Shop name<br><code>2</code> — Brand name</p> |
| `shop_url`    | string  | M           | Public URL of the merchant's shop.                                                                             |
| `description` | string  | O           | Human-readable description of the shop and its intended use.                                                   |

#### Related APIs

* [Add Shop](https://docs.pagsmile.com/remittance-api/business/onboarding/add-shop)
* [Create Corporate Merchant](https://docs.pagsmile.com/remittance-api/business/onboarding/create-corporation)
* [Create Individual](https://docs.pagsmile.com/remittance-api/business/onboarding/create-individual)
* [Delete Shop](https://docs.pagsmile.com/remittance-api/business/onboarding/delete-shop)
* [Query Corporate Merchant](https://docs.pagsmile.com/remittance-api/business/onboarding/query-corporation)
* [Query Individual](https://docs.pagsmile.com/remittance-api/business/onboarding/query-individual)
* [Update Corporate Merchant](https://docs.pagsmile.com/remittance-api/business/onboarding/update-corporation)
* [Update Individual](https://docs.pagsmile.com/remittance-api/business/onboarding/update-individual)