> ## 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 Withdrawal Records

> Query account withdrawal records list based on filter criteria.

## Overview

This page documents the `GET /v1/pay/wallet/withdrawals` endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

## Notes

* Authentication uses the standard GatePay signed headers.
* This page documents the standard merchant endpoint.
* For shared signing rules, see [/api-reference/version/100/en/common/securityAndSignature](/api-reference/version/100/en/common/securityAndSignature).


## OpenAPI

````yaml /api-reference/version/100/en/openapi/withdraw-openapi.json GET /v1/pay/wallet/withdrawals
openapi: 3.1.0
info:
  title: GatePay Withdrawal & Wallet API
  version: 1.0.0
  description: >-
    OpenAPI 3.1 specification for GatePay withdrawal and wallet APIs, based on
    the English withdrawal documentation. It covers batch withdrawals,
    withdrawal status query, supported chains by currency, total balance query,
    and withdrawal fee query.
servers:
  - url: https://openplatform.gateapi.io
    description: Production
security: []
paths:
  /v1/pay/wallet/withdrawals:
    get:
      tags:
        - wallet
      summary: Query Withdrawal Records
      description: Query account withdrawal records list based on filter criteria.
      operationId: getWithdrawals
      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'
        - name: currency
          in: query
          required: false
          schema:
            type: string
          description: Specify currency to query, returns all currencies if empty.
        - name: withdraw_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Withdrawal record ID (starts with 'w', e.g. w1879219868), queries
            single record if specified
        - name: asset_class
          in: query
          required: false
          schema:
            type: string
            enum:
              - SPOT
              - PILOT
          description: >-
            Currency type (Main/Pilot zone), empty by default. Values: SPOT,
            PILOT.
        - name: withdraw_order_id
          in: query
          required: false
          schema:
            type: string
          description: User-defined withdrawal order number for specific record query
        - name: from
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: >-
            Start timestamp (Unix) units in seconds, defaults to last 7 days.
            Query time range cannot exceed 30 days.
        - name: to
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: End timestamp (Unix) units in seconds, defaults to current time.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of records to return.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
          description: Return record offset (starts from 0).
      responses:
        '200':
          description: Withdrawal records list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WithdrawalRecord'
              examples:
                success:
                  summary: Success response
                  value:
                    - id: w1879219868
                      currency: USDT
                      address: THISISTESTADDRESSFORGATEPAY
                      amount: '4.023'
                      fee: '0'
                      txid: Internal transaction 260594131
                      chain: BSC
                      timestamp: '1745220149'
                      status: DONE
                      withdraw_order_id: '202504211521368538928'
                      block_number: '1000'
                      fail_reason: ''
                      type: appbankgp
                      timestamp2: '1745220149'
                      memo: ''
components:
  parameters:
    X-GatePay-Certificate-ClientId:
      name: X-GatePay-Certificate-ClientId
      in: header
      required: true
      description: >-
        The clientId assigned when the merchant registers an application in the
        Gate merchant console.
      schema:
        type: string
        example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: >-
        Request signature. GatePay uses this signature to verify whether the
        request is valid.
      schema:
        type: string
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: >-
        UTC timestamp in milliseconds when the request is generated. GatePay
        will not process requests where the difference from the receive time
        exceeds 10 seconds.
      schema:
        type: string
        example: '1672905655498'
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: >-
        Random string. Must comply with HTTP header rules; recommended length is
        within 32 characters, composed of digits and letters.
      schema:
        type: string
        example: '9578'
  schemas:
    WithdrawalRecord:
      type: object
      description: Withdrawal record details.
      properties:
        id:
          type: string
          description: Transaction record ID.
        txid:
          type: string
          description: Blockchain transaction hash
        block_number:
          type: string
          description: Block number
        withdraw_order_id:
          type: string
          description: Client order ID (max 32 chars, only allows numbers/letters/_/-/.).
        timestamp:
          type: string
          description: Operation time (Unix timestamp in seconds).
        amount:
          type: string
          description: Amount of currency.
        fee:
          type: string
          description: Fee amount.
        currency:
          type: string
          description: Currency name.
        address:
          type: string
          description: Withdrawal address.
        fail_reason:
          type: string
          description: Failure reason (only when status = CANCEL).
        timestamp2:
          type: string
          description: >-
            Final status time: CANCEL - Cancellation time; DONE (block_number>0)
            - Success time.
        memo:
          type: string
          description: Transaction memo/notes.
        status:
          type: string
          description: >-
            Transaction status: DONE (Completed, block_number > 0 means on-chain
            confirmed), CANCEL (Cancelled), REQUEST (Requesting), MANUAL
            (Pending manual review), BCODE (Top-up code operation), EXTPEND
            (Sent awaiting confirmation), FAIL (On-chain failure awaiting
            confirmation), INVALID (Invalid order), VERIFY (Verifying), PROCES
            (Processing), PEND (Processing), DMOVE (Pending manual review),
            REVIEW (Under review).
        chain:
          type: string
          description: Withdrawal chain name.

````