> 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/material/query-material-links.md).

# Query Material Links

**Endpoint**

`POST /remittance/material/query-links`

**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.                                                              |
| `order_id`    | long   | O           | Pagsmile-assigned unique identifier of the order.                                                                 |
| `material_id` | long   | O           | Pagsmile-assigned unique identifier of the material record.                                                       |
| `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`    | int    | O           | <p>One-based page number of the result set.<br>Default: <code>1</code>.</p>                                       |
| `page_size`   | int    | 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,
  "order_id": 100001,
  "material_id": 100001,
  "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/material/query-links \
  --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": 8,
  "random_key": "<RSA-encrypted AES key>",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}
```

**Decrypted `data` example**

```json
[
  {
    "link_id": 100001,
    "material_id": 100001,
    "order_id": 200001,
    "status": 1,
    "created_at": "2026-07-20 10:30:00"
  }
]
```

{% endtab %}

{% tab title="Invalid signature" %}

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

{% endtab %}

{% tab title="403" %}

{% endtab %}
{% endtabs %}

**Response data fields**

| Field         | Type    | Requirement | Description                                                                                                                                     |
| ------------- | ------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `link_id`     | long    | O           | Pagsmile-assigned unique identifier of the association between a material record and a transaction.                                             |
| `material_id` | long    | M           | Pagsmile-assigned unique identifier of the material record.                                                                                     |
| `order_id`    | long    | M           | Pagsmile-assigned unique identifier of the order.                                                                                               |
| `status`      | integer | M           | <p>Current status of the material-to-transaction association.<br>Supported values:<br><code>1</code> — Enabled<br><code>2</code> — Disabled</p> |
| `created_at`  | string  | O           | <p>Date and time when the material record was created.<br>Format: <code>yyyy-MM-dd HH:</code>​<code>mm:ss</code>.</p>                           |

**Related APIs**

* [Cancel Association](https://docs.pagsmile.com/remittance-api/business/material/cancel-association)
* [Create Material](https://docs.pagsmile.com/remittance-api/business/material/create-material)
* [Link Material](https://docs.pagsmile.com/remittance-api/business/material/link-material)
* [Query Materials](https://docs.pagsmile.com/remittance-api/business/material/query-materials)
* [Supplementary Material Document](https://docs.pagsmile.com/remittance-api/business/material/supplementary-material-document)
* [Update Material](https://docs.pagsmile.com/remittance-api/business/material/update-material)