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

# 提现记录查询

> 根据筛选条件查询账户的提现记录列表。

## 概述

本页说明 `GET /payment/open/institution/v1/pay/wallet/withdrawals` 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。

## 说明

* 认证方式使用 GatePay 标准签名请求头。
* 本页展示同一接口的机构路径版本。
* 除创建子账户、查询子账户详情、分页查询子账户外，机构侧请求需携带 `X-GatePay-On-Behalf-Of`。
* 通用签名规则请参见 [/api-reference/version/100/cn/common/securityAndSignature](/api-reference/version/100/cn/common/securityAndSignature)。


## OpenAPI

````yaml api-reference/version/100/cn/openapi/institution/withdraw-openapi.json GET /payment/open/institution/v1/pay/wallet/withdrawals
openapi: 3.1.0
info:
  title: GatePay 提现与钱包 API
  version: 1.0.0
  description: >-
    基于 GatePay 提现与钱包相关文档整理的 OpenAPI 3.1
    规范。涵盖批量提现下单、提现订单查询、币种链查询、账户总额查询以及提现手续费查询等接口。
servers:
  - url: https://openplatform.gateapi.io
    description: 生产环境
security: []
paths:
  /payment/open/institution/v1/pay/wallet/withdrawals:
    get:
      tags:
        - wallet
      summary: 提现记录查询
      description: 根据筛选条件查询账户的提现记录列表。
      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: 指定币种，不填则返回所有币种的提现记录。
        - name: withdraw_id
          in: query
          required: false
          schema:
            type: string
          description: 提现记录 ID（以 w 开头），如指定则查询单条记录。
        - name: asset_class
          in: query
          required: false
          schema:
            type: string
            enum:
              - SPOT
              - PILOT
          description: 币种类型，不填默认全部。可选：SPOT（主板）、PILOT（试验区）。
        - name: withdraw_order_id
          in: query
          required: false
          schema:
            type: string
          description: 用户自定义提现订单号，用于查询指定记录。
        - name: from
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: 起始时间戳（秒，Unix），默认近 7 天。查询时间范围不能超过 30 天。
        - name: to
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: 结束时间戳（秒，Unix），默认当前时间。
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: 返回记录的最大条数。
        - name: offset
          in: query
          required: false
          schema:
            type: integer
          description: 返回记录偏移量（从 0 开始）。
        - $ref: '#/components/parameters/X-GatePay-On-Behalf-Of'
      responses:
        '200':
          description: 提现记录列表
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WithdrawalRecord'
              examples:
                success:
                  summary: 成功响应示例
                  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: 商户客户端ID，在 GatePay 平台申请获得
      schema:
        type: string
        example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: HMAC-SHA256签名，用于验证请求合法性
      schema:
        type: string
        example: >-
          672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: 时间戳（毫秒），与服务器时间差不能超过5分钟
      schema:
        type: string
        example: '1672905655498'
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: 随机数，用于防止重放攻击
      schema:
        type: string
        example: '3525756760'
    X-GatePay-On-Behalf-Of:
      name: X-GatePay-On-Behalf-Of
      in: header
      required: true
      schema:
        type: string
      description: >-
        必填代理归属请求头。请填写本次请求的发起方账户 ID；在机构代理商户 API 中通常填写目标子账户 ID，在机构代扣与划转接口中可填写机构账户
        ID 或子账户 ID。
  schemas:
    WithdrawalRecord:
      type: object
      description: 提现记录明细。
      properties:
        id:
          type: string
          description: 交易记录 ID。
        txid:
          type: string
          description: 区块链交易哈希。
        block_number:
          type: string
          description: 区块高度。
        withdraw_order_id:
          type: string
          description: 客户端订单 ID（最长 32 字符，仅支持数字/字母/_/-/.）。
        timestamp:
          type: string
          description: 操作时间（秒级时间戳，字符串）。
        amount:
          type: string
          description: 提现数量。
        fee:
          type: string
          description: 手续费数量。
        currency:
          type: string
          description: 币种名称。
        address:
          type: string
          description: 提现地址。
        fail_reason:
          type: string
          description: 失败原因（仅在 status 为 CANCEL 时返回）。
        timestamp2:
          type: string
          description: 最终状态时间：CANCEL 为取消时间；DONE 且 block_number>0 为到账时间。
        memo:
          type: string
          description: 交易备注。
        status:
          type: string
          description: >-
            提现状态：DONE、CANCEL、REQUEST、MANUAL、BCODE、EXTPEND、FAIL、INVALID、VERIFY、PROCES、PEND、DMOVE、REVIEW
            等。
        chain:
          type: string
          description: 提现链名称。

````