> 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-materials.md).
# Query Materials
**Endpoint**
`POST /remittance/material/query-materials`
**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. |
| `material_id` | long | O | Pagsmile-assigned unique identifier of the material record. |
| `transaction_type` | integer | O | Business transaction type represented by the record.
See Transaction Type for supported values.
|
| `business_type` | integer | O | Business category represented by the material record and used for compliance review.
Supported values:
10 — Goods trade
11 — Service trade
20 — Platform
21 — Independent platform
|
| `start_date` | string | M | Start of the query period, inclusive.
Format: yyyy-MM-dd HH:mm:ss.
|
| `end_date` | string | M | End of the query period, inclusive.
Format: yyyy-MM-dd HH:mm:ss.
|
| `page_num` | int | O | One-based page number of the result set.
Default: 1.
|
| `page_size` | int | O | Maximum number of records returned on each page.
Default: 10.
Maximum: 30.
|
**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,
"material_id": 100001,
"transaction_type": 1,
"business_type": 1,
"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-materials \
--header 'Content-Type: application/json; charset=UTF-8' \
--data '{
"partner_id": "",
"app_id": "",
"timestamp": "2026-07-20 10:30:00",
"version": "2.0",
"language": "en",
"random_key": "",
"request_id": "",
"sign_type": "RSA",
"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": "",
"total": 8,
"random_key": "",
"sign_type": "RSA",
"app_id": "2017051914172236111"
}
```
**Decrypted `data` example**
```json
[
{
"material_id": 100001,
"material_name": "Invoice INV-20260720-001",
"merchant_id": 100398,
"transaction_type": 101,
"business_type": 10,
"contract_no": "CONTRACT_202607200001",
"contract_date": "2026-07-20",
"buyer_name": "Example Buyer Ltd.",
"buyer_country": "BR",
"amount": "100.00",
"amount_linking": "0.00",
"amount_linked": "100.00",
"currency": "USD",
"platform_name": "Example Marketplace",
"payee_name": "Example Commerce Ltd.",
"created_at": "2026-07-20 10:30:00",
"comments": "Approved after compliance review."
}
]
```
{% 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 |
| ------------------ | ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `material_id` | long | M | Pagsmile-assigned unique identifier of the material record. |
| `material_name` | string | M | Human-readable name of the material record. |
| `merchant_id` | long | M | Pagsmile-assigned unique identifier of the merchant associated with the returned record. |
| `transaction_type` | Integer | M | Business transaction type represented by the record.
See Transaction Type for supported values.
|
| `business_type` | Integer | O | Business category represented by the material record and used for compliance review.
Supported values:
10 — Goods trade
11 — Service trade
20 — Platform
21 — Independent platform
|
| `contract_no` | string | O | Contract number shown in the supporting trade material. |
| `contract_date` | string | O | Date of the supporting contract.
Format: yyyy-MM-dd.
|
| `buyer_name` | string | O | Legal name of the buyer shown in the supporting trade material. |
| `buyer_country` | string | O | Two-letter ISO 3166-1 alpha-2 code of the buyer's country. |
| `amount` | string | O | Monetary amount of the transaction, expressed in the corresponding currency. |
| `amount_linking` | string | O | Total amount currently under review for association with the material. |
| `amount_linked` | string | O | Total amount successfully associated with the material. |
| `currency` | string | O | Three-letter ISO 4217 code of the currency in which the material record values are denominated. |
| `platform_name` | string | O | Name of the commerce platform associated with the transaction. |
| `payee_name` | string | O | Name of the payee or withdrawal beneficiary. |
| `created_at` | string | O | Date and time when the material record was created.
Format: yyyy-MM-dd HH:mm:ss.
|
| `comments` | string | O | Review comments or reason for rejection or failure, when provided. |
**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 Material Links](https://docs.pagsmile.com/remittance-api/business/material/query-material-links)
* [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)