Skip to main content
GET
/
payment
/
open
/
v1
/
pay
/
order
/
list
Query payment 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.

​
Overview

This page documents the Query Payment Order List endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

  • Authentication uses the standard GatePay signed headers.
  • Commonly used for end-of-day reconciliation and reporting sync. Pair with payment callbacks; list queries serve as a fallback data source.
  • For signing rules, see Security and Signature. For integration steps, see Reconciliation.

Headers

​
X-GatePay-ClientId
string
required

Application ClientId.

​
X-GatePay-Signature
string
required

Request signature (HMAC-SHA512).

​
X-GatePay-Timestamp
string
required

Request timestamp in UTC milliseconds.

​
X-GatePay-Nonce
string
required

Random nonce for replay protection.

Body

multipart/form-data

Payment order list query filters (multipart form fields).

​
startTime
string
required

Range start time in milliseconds.

​
endTime
string
required

Range end time in milliseconds.

​
status
enum<string>

Order status filter. Allowed values:

  • PENDING — Pending payment
  • PAID — Payment succeeded
  • ERROR — Payment failed
  • PROCESS — Payment in progress
  • EXPIRED — Expired
  • CANCELLED — Cancelled
  • BLOCK — Abnormal payment
Available options:
PENDING,
PAID,
ERROR,
PROCESS,
EXPIRED,
CANCELLED,
BLOCK
​
payChannel
enum<string>

Payment method filter. Allowed values:

  • GatePay — Gate Pay
  • Web3Pay — Web3 Pay
  • FiatPay — Fiat Pay
Available options:
GatePay,
Web3Pay,
FiatPay
​
payType
enum<string>

Transaction type filter. Allowed values:

  • checkout_pt — Checkout payment
  • address_pt — Address payment
  • call_pt — App invoke payment
  • qrcode_pt — QR code payment
  • web_pt — Web payment
  • mini_pt — GateLife payment
  • payee_pt — Static payee QR code
  • agent_address_pt — AI payment
  • qrcode_ch — Channel QR code payment
  • bank_ch — Bank transfer payment
  • subscription_address_pt — Subscription payment
  • invoicing_pt — Invoicing payment
Available options:
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

Page number, starting from 1.

​
count
string

Number of records per page. Maximum 500.

Response

200 - application/json

Payment order list

​
status
string

API status. SUCCESS indicates success.

​
code
string

Business response code. 000000 indicates success.

​
label
string

Response label.

​
errorMessage
string

Error message when the request fails.

​
data
object