Checkout Order Details
curl --request GET \
--url https://openplatform.gateapi.io/v2/pay/order/query \
--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>'import requests
url = "https://openplatform.gateapi.io/v2/pay/order/query"
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>"
}
response = requests.get(url, headers=headers)
print(response.text)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>'
}
};
fetch('https://openplatform.gateapi.io/v2/pay/order/query', 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.gateapi.io/v2/pay/order/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.gateapi.io/v2/pay/order/query")
.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>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/v2/pay/order/query"
req, _ := http.NewRequest("GET", url, nil)
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.gateapi.io/v2/pay/order/query")
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>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "65466648727916544",
"merchantId": 10002,
"merchantTradeNo": "163",
"transactionId": "65466648727916545",
"goodsName": "charge",
"currency": "USDT",
"orderAmount": "118.75",
"surchargeAmount": "0",
"toleranceAmount": "0",
"underpaidAmount": "0",
"fiatCurrency": "USD",
"fiatAmount": "100",
"fiatRate": "1.1875",
"fiatPayType": "card",
"status": "PAID",
"createTime": 1677573665000,
"expireTime": 1677577265000,
"transactTime": 1677573665219,
"order_name": "test merchant#163",
"pay_currency": "USDT",
"pay_amount": "118.75",
"expectCurrency": "USDT",
"actualCurrency": "USDT",
"actualAmount": "118.75",
"rate": "1",
"channelId": "123456",
"channel_type": "Web3Pay",
"pay_account": "",
"appName": "test merchant",
"appLogo": "https://example.com/app-logo.png",
"address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"fromAddress": "0x1111111111111111111111111111111111111111",
"chain": "MATIC",
"fullCurrType": "USDT_MATIC",
"showChainNameEn": "Polygon",
"txHash": "0xdef456",
"qrcode": "https://www.gate.com/qrcode?content=xxx",
"inUsdt": "118.75",
"totalFee": "118.75",
"location": "https://lotkeys.com/tr/gate-payment-response",
"scheme": "gatepayabcdef01234567",
"merchantName": "test merchant",
"returnUrl": "https://lotkeys.com/tr/gate-payment-response",
"transaction_info": {
"done_amount": "118.75",
"confirming_list": [
{
"amount": "50",
"confirm": 2,
"txId": "0xabc123",
"confirmingTime": 1677573666000,
"complianceStatus": "ACCEPTED"
}
],
"done_list": [
{
"txId": "0xdef456",
"amount": "68.75",
"doneTime": 1677573667000
}
]
},
"whiteBrandInfo": {
"logoUrl": "https://example.com/logo.png",
"brand": "GatePay",
"payWays": [
"GatePay",
"Web3Pay"
]
},
"totalFeeAmount": "0",
"totalInstitutionFeeAmount": "0",
"totalSettleAmount": "118.75",
"payDetails": [
{
"transactionId": "65466648727916545",
"payType": "Web3Pay",
"payTime": "1677573667000",
"payAmount": "118.75",
"payCurrency": "USDT",
"feeAmount": "0",
"institutionFeeAmount": "0",
"settleAmount": "118.75",
"settlementStatus": "done"
}
]
}
}Checkout
Query Checkout Order
Query checkout order details by prepay ID or merchant trade number. Either prepayId or merchantTradeNo is required.
GET
/
v2
/
pay
/
order
/
query
Checkout Order Details
curl --request GET \
--url https://openplatform.gateapi.io/v2/pay/order/query \
--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>'import requests
url = "https://openplatform.gateapi.io/v2/pay/order/query"
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>"
}
response = requests.get(url, headers=headers)
print(response.text)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>'
}
};
fetch('https://openplatform.gateapi.io/v2/pay/order/query', 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.gateapi.io/v2/pay/order/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.gateapi.io/v2/pay/order/query")
.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>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/v2/pay/order/query"
req, _ := http.NewRequest("GET", url, nil)
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.gateapi.io/v2/pay/order/query")
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>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "65466648727916544",
"merchantId": 10002,
"merchantTradeNo": "163",
"transactionId": "65466648727916545",
"goodsName": "charge",
"currency": "USDT",
"orderAmount": "118.75",
"surchargeAmount": "0",
"toleranceAmount": "0",
"underpaidAmount": "0",
"fiatCurrency": "USD",
"fiatAmount": "100",
"fiatRate": "1.1875",
"fiatPayType": "card",
"status": "PAID",
"createTime": 1677573665000,
"expireTime": 1677577265000,
"transactTime": 1677573665219,
"order_name": "test merchant#163",
"pay_currency": "USDT",
"pay_amount": "118.75",
"expectCurrency": "USDT",
"actualCurrency": "USDT",
"actualAmount": "118.75",
"rate": "1",
"channelId": "123456",
"channel_type": "Web3Pay",
"pay_account": "",
"appName": "test merchant",
"appLogo": "https://example.com/app-logo.png",
"address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"fromAddress": "0x1111111111111111111111111111111111111111",
"chain": "MATIC",
"fullCurrType": "USDT_MATIC",
"showChainNameEn": "Polygon",
"txHash": "0xdef456",
"qrcode": "https://www.gate.com/qrcode?content=xxx",
"inUsdt": "118.75",
"totalFee": "118.75",
"location": "https://lotkeys.com/tr/gate-payment-response",
"scheme": "gatepayabcdef01234567",
"merchantName": "test merchant",
"returnUrl": "https://lotkeys.com/tr/gate-payment-response",
"transaction_info": {
"done_amount": "118.75",
"confirming_list": [
{
"amount": "50",
"confirm": 2,
"txId": "0xabc123",
"confirmingTime": 1677573666000,
"complianceStatus": "ACCEPTED"
}
],
"done_list": [
{
"txId": "0xdef456",
"amount": "68.75",
"doneTime": 1677573667000
}
]
},
"whiteBrandInfo": {
"logoUrl": "https://example.com/logo.png",
"brand": "GatePay",
"payWays": [
"GatePay",
"Web3Pay"
]
},
"totalFeeAmount": "0",
"totalInstitutionFeeAmount": "0",
"totalSettleAmount": "118.75",
"payDetails": [
{
"transactionId": "65466648727916545",
"payType": "Web3Pay",
"payTime": "1677573667000",
"payAmount": "118.75",
"payCurrency": "USDT",
"feeAmount": "0",
"institutionFeeAmount": "0",
"settleAmount": "118.75",
"settlementStatus": "done"
}
]
}
}Overview
This page documents theGET /v2/pay/order/query endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.
Notes
- Authentication uses the standard GatePay signed headers.
- This page documents the standard merchant endpoint.
- Provide at least one of
prepayIdormerchantTradeNo. - This endpoint returns the order-query payload directly and does not use the outer
bizType/bizStatuscallback envelope. - For centralized payment orders, interpret
pay_amounttogether withorderAmount. - Treat this endpoint as the final confirmation and reconciliation source rather than something used only during exceptions.
- For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
Headers
Merchant client ID, obtained from GatePay platform
Example:
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
HMAC-SHA256 signature for request validation
Example:
"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"
Millisecond timestamp; the difference from server time must not exceed 30 seconds.
Example:
"1672905655498"
Random nonce for replay attack prevention
Example:
"9578"
Query Parameters
Pre-order ID (either prepayId or merchantTradeNo required)
Merchant order number (either prepayId or merchantTradeNo required)
⌘I

