# Query Materials

### **Request** URL <a href="#payin-by-creditcard" id="payin-by-creditcard"></a>

`POST` `/remittance/material/query-materials`

### **Request Body**

&#x20;**Refer to :** [**common**](https://docs.pagsmile.com/remittance-api/common)

&#x20;**Biz\_data**&#x20;

<table><thead><tr><th width="235.66015625">Name</th><th width="145.58984375">Type</th><th>Description</th></tr></thead><tbody><tr><td>merchant_id<mark style="color:red;">*</mark></td><td>long</td><td>Merchant ID</td></tr><tr><td>material_id</td><td>long</td><td>Material Id</td></tr><tr><td>status</td><td>integer</td><td><p>Material Status</p><p>Refer to <a href="../../data/dictionary-item/all-audit-status">Status</a></p></td></tr><tr><td>start_date<mark style="color:red;">*</mark></td><td>string</td><td><p>Begin time,</p><p>format: yyyy-MM-dd HH:mm:ss</p></td></tr><tr><td>end_date<mark style="color:red;">*</mark></td><td>string</td><td>End time,<br>format: yyyy-MM-dd HH:mm:ss</td></tr><tr><td>page_num</td><td>int</td><td>Default value:1</td></tr><tr><td>page_size</td><td>int</td><td><p>Default value:10, </p><p>Max value is 30</p></td></tr></tbody></table>

{% hint style="info" %}

{% endhint %}

### Response <a href="#example" id="example"></a>

{% tabs %}
{% tab title="200:submit successfully" %}

```
{
    "code": "10000",
    "msg": "Success",
    "data":[
    ],
    "total":8,
    "random_key":"abssdddd2wdw==",
    "sign_type": "RSA",
    "app_id": "2017051914172236111"
}
```

{% endtab %}

{% tab title="400: invalid-signature" %}

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

{% endtab %}
{% endtabs %}

| Name                                                   | Type        | Description                                                                                              |
| ------------------------------------------------------ | ----------- | -------------------------------------------------------------------------------------------------------- |
| merchant\_id<mark style="color:red;">\*</mark>         | string      | Merchant Id                                                                                              |
| material\_name<mark style="color:red;">\*</mark>       | string      | Material Name                                                                                            |
| status<mark style="color:red;">\*</mark>               | integer     | <p>Material Status</p><p>Refer to <a href="../../data/dictionary-item/all-audit-status">Status</a></p>   |
| currency<mark style="color:red;">\*</mark>             | string      | Currency                                                                                                 |
| amount<mark style="color:red;">\*</mark>               | string      | Total Amount                                                                                             |
| amount\_linking                                        | string      | Amount Linking (reviewing)                                                                               |
| amount\_linked                                         | string      | Amount Linked(success)                                                                                   |
| transaction\_type<mark style="color:red;">\*</mark>    | integer     | Transaction Type                                                                                         |
| business\_type<mark style="color:red;">\*</mark>       | integer     | <p>Business Type</p><p>Refer to <a href="../../data/dictionary-item/business-type">Business Type</a></p> |
| buyer\_name                                            | string      | Buyer Name                                                                                               |
| buyer\_country                                         | string      | Buyer Country                                                                                            |
| sender\_name<mark style="color:red;">\*</mark>         | string      | Sender Name                                                                                              |
| sender\_relationship<mark style="color:red;">\*</mark> | string      | Sender Relationship                                                                                      |
| order\_ids                                             | list\<long> | Order IDs                                                                                                |
| created\_at                                            | string      | <p>Created At</p><p> Format:yyyy-MM-dd HH:mm:ss</p>                                                      |
| comments                                               | string      | Reason description                                                                                       |

### Example <a href="#example" id="example"></a>

```

curl --location --request POST 'https://rem-api-sandbox.pagsmile.com/remittance/collection/query-materials' \
--header 'Content-Type: application/json' \
--data-raw '
{
    "partner_id": "000000000000001",
    "app_id": "162051914172236138",
    "timestamp": "2011-09-23 04:24:03",
    "format": "JSON",
    "version": "2.0",
    "random_key": "jJT3+PR9CSowcR2QOK5OzMjVmTSjGoectzYbO8lENHnboElE",
    "request_id": "F6bEd39c-EecF-C1a2-AFcb-bA9BAeC8",
    "sign_type": "RSA",
    "biz_data": "jJT3+PR9CSowcR2QOK5OzMjVmTSjGoectzYbO8lENHnboElEjJT3+PR9CSowcR2QOK5OzMjVmTSjGoectzYbO8lENHnboElE"
}'
```

```
```

Note: **162\*\*\*\*\*\*\*\*\*\*\*\*38** is pagsmile's test app id for sandbox

Please use your own **app\_id** when testing.