> ## 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 /open/institution/v1/deduction/order/list` 接口。完整的请求参数、响应结构与示例由上方关联的 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/subscription/deductionOrderList-openapi.json GET /open/institution/v1/deduction/order/list
openapi: 3.1.0
info:
  title: GatePay 机构订阅 API
  description: GatePay 支付平台 API 接口文档
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://openplatform.gateapi.io/pay-subscription
security: []
paths:
  /open/institution/v1/deduction/order/list:
    get:
      summary: 查询扣款订单列表
      description: 查询扣款订单列表
      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/X-GatePay-On-Behalf-Of'
        - $ref: '#/components/parameters/deductionList_subscriptionOrderNo'
        - $ref: '#/components/parameters/deductionList_merchantSubscriptionOrderNo'
        - $ref: '#/components/parameters/deductionList_payStatus'
        - $ref: '#/components/parameters/deductionList_startTime'
        - $ref: '#/components/parameters/deductionList_endTime'
        - $ref: '#/components/parameters/deductionList_page'
        - $ref: '#/components/parameters/deductionList_count'
      responses:
        '200':
          description: 查询扣款订单列表成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionPlanResponse'
              examples:
                successResponse:
                  summary: 成功响应
                  value:
                    code: '0'
                    message: ''
                    data:
                      total: 1
                      list:
                        - subscriptionOrderNo: '70778338049917032'
                          merchantSubscriptionOrderNo: rhys-81
                          planNo: '70778338049916930'
                          paymentOrderNo: '70778338049917033'
                          merchantDeductNo: ''
                          txHash: >-
                            0x658d3a403a4d6879dfd94229270a13e04249b50020ead15f6b7dceeb11286aee
                          merchantId: '10002'
                          cryptoCurrency: USDT
                          chain: BSC
                          userAddress: '0xbe6D780C23E77D979Fad5FbEa249a44E5cAC0463'
                          merchantAddress: '0xeEfAe46E6551E54879C80C16882f745c25361473'
                          cryptoAmount: '0.01000000'
                          isDiscounted: false
                          payTime: 1773989575000
                          payStatus: SUCCESS
                          description: null
                          failReason: null
                    success: true
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: '9578'
    X-GatePay-On-Behalf-Of:
      name: X-GatePay-On-Behalf-Of
      in: header
      required: true
      schema:
        type: string
      description: >-
        必填代理归属请求头。请填写本次请求的发起方账户 ID；在机构代理商户 API 中通常填写目标子账户 ID，在机构代扣与划转接口中可填写机构账户
        ID 或子账户 ID。
    deductionList_subscriptionOrderNo:
      name: subscriptionOrderNo
      in: query
      required: false
      description: >-
        订阅订单编号与merchantSubscriptionOrderNo任选一个） subscriptionOrderNo 与
        merchantSubscriptionOrderNo 至少填一个
      schema:
        type: string
    deductionList_merchantSubscriptionOrderNo:
      name: merchantSubscriptionOrderNo
      in: query
      required: false
      description: >-
        商户订阅订单编号（与subscriptionOrderNo任选一个） subscriptionOrderNo 与
        merchantSubscriptionOrderNo 至少填一个
      schema:
        type: string
    deductionList_payStatus:
      name: payStatus
      in: query
      required: false
      description: 扣款状态筛选：SUCCESS/FAIL/BLOCK
      schema:
        type: string
    deductionList_startTime:
      name: startTime
      in: query
      required: false
      description: 扣款开始时间，毫秒时间戳
      schema:
        type: integer
        format: int64
    deductionList_endTime:
      name: endTime
      in: query
      required: false
      description: 扣款结束时间，毫秒时间戳，最长1年
      schema:
        type: integer
        format: int64
    deductionList_page:
      name: page
      in: query
      required: false
      description: 页码，从1开始
      schema:
        type: integer
        format: int32
        minimum: 1
        example: 1
    deductionList_count:
      name: count
      in: query
      required: false
      description: 每页数量，最大100
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        example: 10
  schemas:
    CreateSubscriptionPlanResponse:
      type: object
      properties:
        total:
          type: integer
          description: 总数量
        list:
          type: array
          description: 扣款记录列表
          items:
            type: object
            properties:
              subscriptionOrderNo:
                type: string
                description: 订阅订单编号
              merchantSubscriptionOrderNo:
                type: string
                description: 商户订阅订单编号
              planNo:
                type: string
                description: 订阅计划编号
              paymentOrderNo:
                type: string
                description: 发起订阅扣款的订单号
              txHash:
                type: string
                description: 链上交易ID
              merchantId:
                type: string
                description: 创建订阅计划的商户编号
              cryptoCurrency:
                type: string
                description: 加密货币币种
              chain:
                type: string
                description: 加密货币网络
              userAddress:
                type: string
                description: 用户付款链上地址
              merchantAddress:
                type: string
                description: 平台接收扣款的地址
              cryptoAmount:
                type: string
                description: 单次扣款金额
              isDiscounted:
                type: boolean
                description: 是否为特价扣款
              discountInfo:
                type: object
                description: 特价信息（如有）
              payTime:
                type: integer
                format: int64
                description: 创建扣款订单的时间
              payStatus:
                type: string
                description: 扣款状态：SUCCESS/FAIL/BLOCK

````