> ## 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.

# Query Payout Order List

> Query payout (withdrawal) sub-orders by time range with pagination. Supports filtering by batch ID, status, audit status, and other criteria.

## 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](/api-reference/version/100/en/common/securityAndSignature). For integration steps, see [Reconciliation](/essentials/version/100/en/common/reconciliation).


## OpenAPI

````yaml /api-reference/version/100/en/openapi/reconciliation-openapi.json GET /withdraw/open/v1/withdraw/suborder/query
openapi: 3.1.0
info:
  title: GatePay Reconciliation API
  version: 1.0.0
  description: OpenAPI specification for GatePay reconciliation order list APIs.
servers:
  - url: https://openplatform.gateapi.io
    description: Production
security: []
paths:
  /withdraw/open/v1/withdraw/suborder/query:
    get:
      tags:
        - reconciliation
      summary: Query payout sub-order list
      description: >-
        Query payout (withdrawal) sub-orders by time range with pagination.
        Supports filtering by batch ID, status, audit status, and other
        criteria.
      operationId: listReconciliationWithdrawSuborders
      parameters:
        - $ref: '#/components/parameters/X-GatePay-Certificate-ClientId'
        - $ref: '#/components/parameters/X-GatePay-Signature'
        - $ref: '#/components/parameters/X-GatePay-Timestamp'
        - $ref: '#/components/parameters/X-GatePay-Nonce'
        - $ref: '#/components/parameters/withdrawSuborderList_page'
        - $ref: '#/components/parameters/withdrawSuborderList_count'
        - $ref: '#/components/parameters/withdrawSuborderList_start_time'
        - $ref: '#/components/parameters/withdrawSuborderList_end_time'
        - $ref: '#/components/parameters/withdrawSuborderList_status'
        - $ref: '#/components/parameters/withdrawSuborderList_channel_id'
        - $ref: '#/components/parameters/withdrawSuborderList_audit_status'
      responses:
        '200':
          description: Payout sub-order list
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ReconciliationWithdrawSuborderListResponse
              examples:
                success:
                  summary: Successful response
                  value:
                    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
components:
  parameters:
    X-GatePay-Certificate-ClientId:
      name: X-GatePay-Certificate-ClientId
      in: header
      required: true
      description: Application ClientId.
      schema:
        type: string
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: Request signature (HMAC-SHA512).
      schema:
        type: string
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: Request timestamp in UTC milliseconds.
      schema:
        type: string
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: Random nonce for replay protection.
      schema:
        type: string
    withdrawSuborderList_page:
      name: page
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
      description: Page number, starting from 1.
    withdrawSuborderList_count:
      name: count
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        maximum: 500
      description: Number of records per page. Maximum 500.
    withdrawSuborderList_start_time:
      name: start_time
      in: query
      required: true
      schema:
        type: integer
        format: int64
      description: Range start time in milliseconds.
    withdrawSuborderList_end_time:
      name: end_time
      in: query
      required: true
      schema:
        type: integer
        format: int64
      description: Range end time in milliseconds.
    withdrawSuborderList_status:
      name: status
      in: query
      required: false
      schema:
        type: string
        enum:
          - INIT
          - PENDING
          - CHECK
          - PROCESSING
          - DONE
          - FAIL
      description: |-
        Sub-order status filter. Allowed values:

        - `INIT` — Created
        - `PENDING` — Pending
        - `CHECK` — Under review
        - `PROCESSING` — Processing
        - `DONE` — Payout succeeded
        - `FAIL` — Payout failed
    withdrawSuborderList_channel_id:
      name: channel_id
      in: query
      required: false
      schema:
        type: string
      description: Merchant channel ID filter.
    withdrawSuborderList_audit_status:
      name: audit_status
      in: query
      required: false
      schema:
        type: string
        enum:
          - AUDITING
          - AUDIT_SUCCESS
          - AUDIT_REJECT
          - AUDIT_TIMEOUT
      description: |-
        Approval / audit status filter. Allowed values:

        - `AUDITING` — Under review
        - `AUDIT_SUCCESS` — Approved
        - `AUDIT_REJECT` — Rejected
        - `AUDIT_TIMEOUT` — Review timed out
  schemas:
    ReconciliationWithdrawSuborderListResponse:
      type: object
      properties:
        status:
          type: string
          description: API status. `SUCCESS` indicates success.
        code:
          type: string
          description: Business response code. `000000` indicates success.
        label:
          type: string
          description: Response label.
        errorMessage:
          type: string
          description: Error message when the request fails.
        data:
          $ref: '#/components/schemas/ReconciliationWithdrawSuborderListData'
    ReconciliationWithdrawSuborderListData:
      type: object
      properties:
        merchant_id:
          type: integer
          format: int64
          description: Merchant ID.
        total:
          type: integer
          format: int64
          description: Total number of matching sub-orders.
        total_amount:
          type: string
          description: Total withdrawal amount in the query result set (aggregated).
        order_count:
          type: integer
          format: int64
          description: Number of orders in the result set.
        user_count:
          type: integer
          format: int64
          description: Number of distinct users in the result set.
        suborder_list:
          type: array
          description: Payout sub-order list for the current page.
          items:
            $ref: '#/components/schemas/ReconciliationWithdrawSuborderItem'
    ReconciliationWithdrawSuborderItem:
      type: object
      description: Payout sub-order list item.
      properties:
        create_time:
          type: integer
          format: int64
          description: Creation time in milliseconds.
        finish_time:
          type: integer
          format: int64
          description: Completion time in milliseconds.
        batch_id:
          type: string
          description: Batch ID.
        merchant_withdraw_id:
          type: string
          description: Merchant withdrawal ID.
        suborder_id:
          type: string
          description: GatePay sub-order ID.
        withdraw_id:
          type: string
          description: Withdrawal transaction ID.
        currency:
          type: string
          description: Currency.
        amount:
          type: string
          description: Requested withdrawal amount.
        fee:
          type: string
          description: Fee amount.
        fee_type:
          type: integer
          description: >-
            Fee type: `0` — amount is deduction amount; `1` — amount is received
            amount.
        chain:
          type: string
          description: Blockchain network.
        show_chain_name:
          type: string
          description: Display name of the blockchain network.
        address:
          type: string
          description: Withdrawal address.
        channel_id:
          type: string
          description: Merchant channel ID.
        desc:
          type: string
          description: Channel remarks.
        status:
          type: string
          description: Sub-order status.
        pay_status:
          type: string
          description: Payment / fund movement status.
        pay_amount:
          type: string
          description: Deducted amount.
        pay_time:
          type: integer
          format: int64
          description: Payment time in milliseconds.
        pay_account:
          type: string
          description: Payment account identifier.
        done_amount:
          type: string
          description: Amount actually received.
        memo:
          type: string
          description: Transfer memo.
        tx_id:
          type: string
          description: On-chain transaction hash.
        err_msg:
          type: string
          description: Failure reason when the payout did not succeed.
        from_address:
          type: string
          description: Source on-chain address for the payout.
        settle_merchant_id:
          type: integer
          format: int64
          description: Settlement merchant ID.

````