跳转到主要内容
GET
/
payment
/
open
/
v1
/
pay
/
order
/
list
查询收款订单列表
curl --request GET \
  --url https://openplatform.gateapi.io/payment/open/v1/pay/order/list \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-GatePay-ClientId: <x-gatepay-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --form 'startTime=<string>' \
  --form 'endTime=<string>'
{
  "status": "SUCCESS",
  "code": "000000",
  "label": "",
  "errorMessage": "",
  "data": {
    "Total": 1,
    "orderList": [
      {
        "refund_info": {
          "canRefund": false,
          "refundSuccessAmount": "0",
          "refundProcessAmount": "0",
          "refundSuccessTimes": 0,
          "refundFailTimes": 0,
          "refundCurrency": "USDT",
          "canNotRefundReason": "",
          "totalRequestAmount": "0",
          "totalRequestCurrency": "USDT",
          "existRefund": false
        },
        "create_time": 1766470410668,
        "pay_type": "",
        "is_refund": false,
        "refund_amount": 0,
        "refund_currency": "",
        "settleMerchantId": 10002,
        "orderType": "",
        "merchantTradeNo": "M202405290001",
        "orderId": "63546113486749696",
        "goodsName": "",
        "orderCurrency": "USDT",
        "orderAmount": 100,
        "payCurrency": "USDT",
        "payAmount": 100,
        "surchargeAmount": 0,
        "payableAmount": 100,
        "receiveCurrency": "USDT",
        "receiveAmount": 100,
        "addressPayAmount": {
          "currency": "USDT",
          "inTerm": 0,
          "outTerm": 0
        },
        "generalizedStatus": "PAY_SUCCESS",
        "payChannel": "gate",
        "billType": 0,
        "chain": "",
        "orderTime": 1766474310668,
        "clientId": "",
        "channelId": "123456",
        "fromAddress": "",
        "settleCurrency": "USDT",
        "platFeeAmount": 0,
        "merchantSettleAmount": 100,
        "fiatCurrency": "",
        "fiatAmount": "",
        "fiatRate": "",
        "refundTime": 0,
        "failReason": "",
        "buyer": "",
        "uid": "",
        "fundStatus": "",
        "newPayType": "gate",
        "address": "",
        "status": "",
        "institutionFeeAmount": 0,
        "hashes": "",
        "originalOrderId": "",
        "originMerchantTradeNo": ""
      }
    ]
  }
}

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.

概述

本页说明「查询收款订单列表」接口。完整的请求参数、响应结构与示例由关联的 OpenAPI 定义渲染。

说明

  • 认证方式使用 GatePay 标准签名请求头。
  • 常用于日终对账、报表同步;建议与支付回调配合,列表查询可作为兜底数据源。
  • 通用签名规则见 安全与签名;接入步骤见 对账指引

请求头

X-GatePay-ClientId
string
必填

应用 ClientId。

X-GatePay-Signature
string
必填

请求签名(HMAC-SHA512)。

X-GatePay-Timestamp
string
必填

请求时间戳(UTC 毫秒)。

X-GatePay-Nonce
string
必填

随机数,用于防重放。

请求体

multipart/form-data

收款订单列表查询条件(multipart 表单字段)。

startTime
string
必填

查询起始时间(毫秒)。

endTime
string
必填

查询结束时间(毫秒)。

status
enum<string>

订单状态筛选。可用取值:

  • PENDING — 待支付
  • PAID — 支付成功
  • ERROR — 支付失败
  • PROCESS — 支付中
  • EXPIRED — 已过期
  • CANCELLED — 已取消
  • BLOCK — 支付异常
可用选项:
PENDING,
PAID,
ERROR,
PROCESS,
EXPIRED,
CANCELLED,
BLOCK
payChannel
enum<string>

支付方式筛选。可用取值:

  • GatePay — Gate 支付
  • Web3Pay — Web3 支付
  • FiatPay — 法币支付
可用选项:
GatePay,
Web3Pay,
FiatPay
payType
enum<string>

交易类型筛选。可用取值:

  • checkout_pt — 收银台支付
  • address_pt — 地址支付
  • call_pt — 调起 App 支付
  • qrcode_pt — 扫码支付
  • web_pt — Web 端支付
  • mini_pt — GateLife 支付
  • payee_pt — 静态收款码
  • agent_address_pt — AI 支付
  • qrcode_ch — 渠道扫码支付
  • bank_ch — 银行转账支付
  • subscription_address_pt — 订阅支付
  • invoicing_pt — 账单支付
可用选项:
checkout_pt,
address_pt,
call_pt,
qrcode_pt,
web_pt,
mini_pt,
payee_pt,
agent_address_pt,
qrcode_ch,
bank_ch,
subscription_address_pt,
invoicing_pt
page
string

页码,从 1 开始。

count
string

每页条数,最大 500。

响应

200 - application/json

收款订单列表

status
string

接口状态,SUCCESS 表示成功。

code
string

业务响应码,000000 表示成功。

label
string

响应标签。

errorMessage
string

失败时的错误描述。

data
object