---
title: "Query withdrawal order status"
method: POST
path: "/v1/pay/withdraw/query"
tags: ["withdraw"]
---

# Query withdrawal order status

`POST /v1/pay/withdraw/query`

Query the status and details of a batch withdrawal order and its sub-orders by batch ID and detail status.

## Headers

- `X-GatePay-Certificate-ClientId` string, required
- `X-GatePay-Signature` string, required
- `X-GatePay-Timestamp` string, required
- `X-GatePay-Nonce` string, required

## Request body

- WithdrawQueryRequest — Request body for querying batch withdrawal status.
  - `batch_id` string, required — Unique batch ID generated by the merchant at /v1/pay/withdraw.
  - `detail_status` string, required — Query status of sub-orders <br> ALL: all sub-orders <br>INIT ：new added sub-orders <br>PENDING: pending sub-orders <br>PROCESSING: submitted withdrawal request, pending confirmation <br>CHECK: in review <br>FAIL: failed sub-orders <br>DONE: successful sub-orders.

## Response `200`

Withdrawal batch details

- WithdrawQueryResponse — Response body for querying batch withdrawal status.
  - `status` string, required — Main order status: INIT (newly created order), PROCESSING (newly created payout order is in processing), PARTIAL (partially successful), FAIL (fully failed), SUCCESS (fully successful)
  - `code` string, required — Error code
  - `errorMessage` string — Error message
  - `data` object — Batch withdrawal details
    - `batch_id` string — Batch ID.
    - `merchant_id` integer — Merchant ID.
    - `client_id` string — Client ID.
    - `status` string — Main order status: INIT (newly created order), PROCESSING (newly created payout order is in processing), PARTIAL (partially successful), FAIL (fully failed), SUCCESS (fully successful).
    - `create_time` integer — Main order creation time.
    - `channel_id` string — Customer channel name.
    - `withdraw_list` WithdrawSubOrder[] — Sub-order information.
      - `id` integer — Record ID.
      - `batch_id` string — Merchant batch withdrawal ID.
      - `merchant_id` integer — Merchant ID.
      - `channel_id` string — Customer channel name.
      - `suborder_id` string — Sub-order ID generated by GatePay.
      - `chain` string — Blockchain network.
      - `address` string — Withdrawal address.
      - `currency` string — Currency.
      - `amount` string, decimal — Initiated withdrawal amount
      - `fee` string, decimal — Fee amount.
      - `tx_id` string — Blockchain transaction hash.
      - `timestamp` integer — Deposit/withdrawal operation time.
      - `memo` string — Transfer memo and other note information.
      - `status` string — Sub-order status: INIT (newly created sub-order), PENDING (order created, pending processing), PROCESSING (order is being processed), CHECK (under review), FAIL (withdrawal failed), DONE (withdrawal successful)
      - `merchant_withdraw_id` string — Merchant withdrawal ID.
      - `err_msg` string — Reason for withdrawal failure.
      - `create_time` integer — Creation time.
      - `update_time` integer — Update time.
      - `done_amount` string, decimal — Actual received amount.

---

[API](https://skmtc.net/gate/apis/gatepay-withdrawal-wallet-api.md) · [All operations](https://skmtc.net/gate/apis/gatepay-withdrawal-wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gate/gatepay-withdrawal-wallet-api/versions/4feb16b0979e/schema)