Skip to main content
GET
/
withdraw
/
open
/
v1
/
withdraw
/
suborder
/
query
Query payout sub-order list
curl --request GET \
  --url https://openplatform.gateapi.io/withdraw/open/v1/withdraw/suborder/query \
  --header 'X-GatePay-ClientId: <x-gatepay-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "status": "SUCCESS",
  "code": "000000",
  "label": "",
  "errorMessage": "",
  "data": {
    "merchant_id": 10002,
    "total": 1,
    "total_amount": "1",
    "order_count": 1,
    "user_count": 1,
    "suborder_list": [
      {
        "create_time": 1726055848856,
        "finish_time": 1726055856011,
        "batch_id": "237394559478075350",
        "merchant_withdraw_id": "M137394559478075550",
        "suborder_id": "268830764354768896",
        "withdraw_id": "268830764354768896",
        "currency": "USDT",
        "amount": "1",
        "fee": "0",
        "fee_type": 1,
        "chain": "ETH",
        "show_chain_name": "Ethereum",
        "address": "0x1234567890abcdef",
        "channel_id": "123456",
        "desc": "",
        "status": "DONE",
        "pay_status": "DONE",
        "pay_amount": "1",
        "pay_time": 1726055856011,
        "pay_account": "",
        "done_amount": "1",
        "memo": "",
        "tx_id": "0xabc123",
        "err_msg": "",
        "from_address": "",
        "settle_merchant_id": 10002
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gate.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This page documents the Query Payout Sub-order List endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

  • Authentication uses the standard GatePay signed headers.
  • Commonly used for reconciliation fallback and audit tracing. Pair with payout callbacks; list queries complement callback delivery.
  • For signing rules, see Security and Signature. For integration steps, see Reconciliation.

Headers

​
X-GatePay-ClientId
string
required

Application ClientId.

​
X-GatePay-Signature
string
required

Request signature (HMAC-SHA512).

​
X-GatePay-Timestamp
string
required

Request timestamp in UTC milliseconds.

​
X-GatePay-Nonce
string
required

Random nonce for replay protection.

Query Parameters

​
page
integer
required

Page number, starting from 1.

Required range: x >= 1
​
count
integer
required

Number of records per page. Maximum 500.

Required range: 1 <= x <= 500
​
start_time
integer<int64>
required

Range start time in milliseconds.

​
end_time
integer<int64>
required

Range end time in milliseconds.

​
status
string

Sub-order status filter. Common values include CREATED, PENDING, UNDER_REVIEW, PROCESSING, PAYOUT_SUCCESS, and PAYOUT_FAIL.

​
channel_id
string

Merchant channel ID filter.

​
audit_status
enum<string>

Approval / audit status filter. Allowed values:

  • AUDITING — Under review
  • AUDIT_SUCCESS — Approved
  • AUDIT_REJECT — Rejected
  • AUDIT_TIMEOUT — Review timed out
Available options:
AUDITING,
AUDIT_SUCCESS,
AUDIT_REJECT,
AUDIT_TIMEOUT

Response

200 - application/json

Payout sub-order list

​
status
string

API status. SUCCESS indicates success.

​
code
string

Business response code. 000000 indicates success.

​
label
string

Response label.

​
errorMessage
string

Error message when the request fails.

​
data
object