跳转到主要内容
GET
/
open
/
institution
/
v1
/
deduction
/
order
/
list
查询扣款订单列表
curl --request GET \
  --url https://openplatform.gateapi.io/pay-subscription/open/institution/v1/deduction/order/list \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "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
}

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

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID,在 GatePay 平台申请获得

示例:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
必填

HMAC-SHA256签名,用于验证请求合法性

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
必填

时间戳(毫秒),与服务器时间差不能超过5分钟

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数,用于防止重放攻击

示例:

"9578"

X-GatePay-On-Behalf-Of
string
必填

必填代理归属请求头。请填写本次请求的发起方账户 ID;在机构代理商户 API 中通常填写目标子账户 ID,在机构代扣与划转接口中可填写机构账户 ID 或子账户 ID。

查询参数

subscriptionOrderNo
string

订阅订单编号与merchantSubscriptionOrderNo任选一个) subscriptionOrderNo 与 merchantSubscriptionOrderNo 至少填一个

merchantSubscriptionOrderNo
string

商户订阅订单编号(与subscriptionOrderNo任选一个) subscriptionOrderNo 与 merchantSubscriptionOrderNo 至少填一个

payStatus
string

扣款状态筛选:SUCCESS/FAIL/BLOCK

startTime
integer<int64>

扣款开始时间,毫秒时间戳

endTime
integer<int64>

扣款结束时间,毫秒时间戳,最长1年

page
integer<int32>

页码,从0开始

必填范围: x >= 1
示例:

1

count
integer<int32>

每页数量,最大100

必填范围: 1 <= x <= 100
示例:

10

响应

200 - application/json

查询扣款订单列表成功

total
integer

总数量

list
object[]

扣款记录列表