Query Payment Order List

Query payment order list

curl --request GET \
  --url https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-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>'

import requests

url = "https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "Content-Type": "multipart/form-data"
}

response = requests.get(url, data=payload, headers=headers)

print(response.text)

const form = new FormData();
form.append('startTime', '<string>');
form.append('endTime', '<string>');

const options = {
  method: 'GET',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>'
  }
};

options.body = form;

fetch('https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "status": "SUCCESS",
  "code": "000000",
  "label": "",
  "errorMessage": "",
  "data": {
    "Total": 1,
    "orderList": [
      {
        "refund_info": {
          "canRefund": false,
          "refundSuccessAmount": "0",
          "refundProcessAmount": "0",
          "refundSuccessTimes": 0,
          "refundFailTimes": 0,
          "refundCurrency": "USDC",
          "canNotRefundReason": "",
          "totalRequestAmount": "0",
          "totalRequestCurrency": "USDC",
          "existRefund": false
        },
        "create_time": 1766470410668,
        "pay_type": "",
        "is_refund": false,
        "refund_amount": 0,
        "refund_currency": "",
        "settleMerchantId": 10002,
        "orderType": "",
        "merchantTradeNo": "M202405290001",
        "orderId": "63546113486749696",
        "goodsName": "",
        "orderCurrency": "USDC",
        "orderAmount": 100,
        "payCurrency": "USDC",
        "payAmount": 100,
        "surchargeAmount": 0,
        "payableAmount": 100,
        "receiveCurrency": "USDC",
        "receiveAmount": 100,
        "addressPayAmount": {
          "currency": "USDC",
          "inTerm": 0,
          "outTerm": 0
        },
        "generalizedStatus": "PAY_SUCCESS",
        "payChannel": "gate",
        "billType": 0,
        "chain": "",
        "orderTime": 1766474310668,
        "clientId": "",
        "channelId": "123456",
        "fromAddress": "",
        "settleCurrency": "USDC",
        "platFeeAmount": 0,
        "merchantSettleAmount": 100,
        "fiatCurrency": "",
        "fiatAmount": "",
        "fiatRate": "",
        "refundTime": 0,
        "failReason": "",
        "buyer": "",
        "uid": "",
        "fundStatus": "",
        "newPayType": "gate",
        "address": "",
        "status": "",
        "institutionFeeAmount": 0,
        "hashes": "",
        "originalOrderId": "",
        "originMerchantTradeNo": ""
      }
    ]
  }
}

GET

payment

open

pay

order

list

Query payment order list

curl --request GET \
  --url https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-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>'

import requests

url = "https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "Content-Type": "multipart/form-data"
}

response = requests.get(url, data=payload, headers=headers)

print(response.text)

const form = new FormData();
form.append('startTime', '<string>');
form.append('endTime', '<string>');

const options = {
  method: 'GET',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>'
  }
};

options.body = form;

fetch('https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform-eu.gateapi.io/payment/open/v1/pay/order/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"startTime\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"endTime\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "status": "SUCCESS",
  "code": "000000",
  "label": "",
  "errorMessage": "",
  "data": {
    "Total": 1,
    "orderList": [
      {
        "refund_info": {
          "canRefund": false,
          "refundSuccessAmount": "0",
          "refundProcessAmount": "0",
          "refundSuccessTimes": 0,
          "refundFailTimes": 0,
          "refundCurrency": "USDC",
          "canNotRefundReason": "",
          "totalRequestAmount": "0",
          "totalRequestCurrency": "USDC",
          "existRefund": false
        },
        "create_time": 1766470410668,
        "pay_type": "",
        "is_refund": false,
        "refund_amount": 0,
        "refund_currency": "",
        "settleMerchantId": 10002,
        "orderType": "",
        "merchantTradeNo": "M202405290001",
        "orderId": "63546113486749696",
        "goodsName": "",
        "orderCurrency": "USDC",
        "orderAmount": 100,
        "payCurrency": "USDC",
        "payAmount": 100,
        "surchargeAmount": 0,
        "payableAmount": 100,
        "receiveCurrency": "USDC",
        "receiveAmount": 100,
        "addressPayAmount": {
          "currency": "USDC",
          "inTerm": 0,
          "outTerm": 0
        },
        "generalizedStatus": "PAY_SUCCESS",
        "payChannel": "gate",
        "billType": 0,
        "chain": "",
        "orderTime": 1766474310668,
        "clientId": "",
        "channelId": "123456",
        "fromAddress": "",
        "settleCurrency": "USDC",
        "platFeeAmount": 0,
        "merchantSettleAmount": 100,
        "fiatCurrency": "",
        "fiatAmount": "",
        "fiatRate": "",
        "refundTime": 0,
        "failReason": "",
        "buyer": "",
        "uid": "",
        "fundStatus": "",
        "newPayType": "gate",
        "address": "",
        "status": "",
        "institutionFeeAmount": 0,
        "hashes": "",
        "originalOrderId": "",
        "originMerchantTradeNo": ""
      }
    ]
  }
}

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.

Headers

X-GatePay-Certificate-ClientId

string

required

Application ClientId.

X-GatePay-Signature

string

required

Request signature (HMAC-SHA512).

X-GatePay-Timestamp

string

required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

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

Note: the EU site currently supports GatePay only.

Available options:

GatePay

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

Show child attributes

Common

Balance

Payment

Convert

Payout

Reconciliation

Notifications

Query Payment Order List

Overview

Notes

Headers

Body

Response

​Overview

​Notes

Headers

Body

Response

Overview

Notes