> 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/withdrawal/query-withdrawal-orders.md).
# Query Withdrawal Orders
Retrieves withdrawal orders for a merchant within a specified time range, with optional filters and pagination.
#### Endpoint
`POST /remittance/withdrawal/query-orders`
**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 | O | Pagsmile-assigned unique identifier of the merchant on whose behalf the request is submitted. |
| `order_no` | string | O | Merchant-defined order number used to submit, query, and reconcile the withdrawal order. |
| `order_status` | int | O | Current processing status of the order.
See Order Status for supported values.
|
| `account_num` | string | O | Registered bank account number to which the withdrawal is sent. |
| `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.
|
{% hint style="info" %}
Max query time range 7 days
{% endhint %}
**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_no": "ORDER_202607200001",
"order_status": 1,
"account_num": "1234567890",
"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/withdrawal/query-orders \
--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" %}
```json
{
"code": "10000",
"msg": "Success",
"data": {
},
"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 |
| ----------------------- | ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `order_id` | long | M | Pagsmile-assigned unique identifier of the order. |
| `merchant_id` | long | M | Pagsmile-assigned unique identifier of the merchant associated with the returned withdrawal order. |
| `transaction_id` | long | O | Pagsmile-assigned unique identifier of the transaction. |
| `order_no` | string | M | Merchant-defined order number used to submit, query, and reconcile the withdrawal order. |
| `order_status` | integer | M | Current processing status of the withdrawal order.
See Order Status for supported values.
|
| `audit_status` | integer | O | Current compliance or material review status of the withdrawal order. |
| `bank_country` | string | O | Two-letter ISO 3166-1 alpha-2 code of the country where the bank account is held. |
| `pay_currency` | string | O | Three-letter ISO 4217 code of the currency debited for the transaction. |
| `pay_amount` | string | O | Amount debited in the payment currency. |
| `fee` | string | O | Service fee charged for the transaction, expressed in the corresponding currency. |
| `payed_at` | string | O | Date and time when the order was paid. Format: `yyyy-MM-dd HH:mm:ss`. |
| `refund_transaction_id` | long | O | Unique identifier of the refund transaction. |
| `refund_fee` | string | O | Fee charged or returned as part of the refund. |
| `refunded_at` | string | O | Date and time when the refund was completed. Format: `yyyy-MM-dd HH:mm:ss`. |
| `receive_currency` | string | M | Three-letter ISO 4217 code of the currency credited to the recipient. |
| `receive_amount` | string | M | Amount credited in the receiving currency. |
| `account_num` | string | O | Registered bank account number to which the withdrawal is sent. |
| `payee_name` | string | O | Name of the payee or withdrawal beneficiary. |
| `payee_id` | long | O | Unique identifier of the payee or withdrawal beneficiary. |
| `reference` | string | O | Merchant-provided reference used to reconcile the withdrawal order with the merchant's internal records. |
| `error_message` | string | O | Human-readable explanation provided when processing fails. |
| `created_at` | string | O | Date and time when the withdrawal order was created. Format: `yyyy-MM-dd HH:mm:ss`. |
#### Related APIs
* [Add Withdrawal Account](https://docs.pagsmile.com/remittance-api/business/withdrawal/add-withdrawal-account)
* [Create Withdrawal Order](https://docs.pagsmile.com/remittance-api/business/withdrawal/create-withdrawal-order)
* [Delete Withdrawal Account](https://docs.pagsmile.com/remittance-api/business/withdrawal/delete-withdrawal-account)
* [Query Withdrawal Account Detail](https://docs.pagsmile.com/remittance-api/business/withdrawal/query-withdrawal-account-detail)
* [Update Withdrawal Account](https://docs.pagsmile.com/remittance-api/business/withdrawal/update-withdrawal-account)
* [Withdrawal Result Notification](https://docs.pagsmile.com/remittance-api/business/withdrawal/withdrawal-result-notification)