Skip to main content
POST
/
v1
/
pay
/
order
/
query
Query order status
curl --request POST \
  --url https://openplatform.gateapi.io/v1/pay/order/query \
  --header 'Content-Type: application/json' \
  --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>' \
  --data '
{
  "merchantTradeNo": "56236"
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "prepayId": "50620368071692288",
    "merchantId": 10002,
    "merchantTradeNo": "4379824792349592345",
    "transactionId": "",
    "goodsName": "NFT",
    "currency": "GT",
    "orderAmount": "0.1",
    "status": "EXPIRED",
    "createTime": 1674030436229,
    "expireTime": 1663054706000,
    "transactTime": 0,
    "order_name": "MiniApp-Payment#4379824792349592345",
    "pay_currency": "",
    "pay_amount": "0",
    "rate": "0",
    "channel_type": "",
    "inUsdt": "",
    "appLogo": "https://gimg2.gateimg.com/image/432c2715a0eaa6217af7a3db1e85ffc8dc866233.webp",
    "appName": "Latiago",
    "channelId": "123456",
    "totalFeeAmount": "0",
    "totalSettleAmount": "",
    "payDetails": []
  }
}

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 POST /v1/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.
  • This endpoint returns the order-query payload directly and does not use the outer bizType / bizStatus callback envelope.
  • For centralized payment orders, interpret pay_amount together with orderAmount.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform

Example:

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

​
X-GatePay-Signature
string
required

HMAC-SHA256 signature for request validation

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

​
X-GatePay-Timestamp
string
required

Timestamp in milliseconds, must be within 5 minutes of server time

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random nonce for replay attack prevention

Example:

"3525756760"

Body

application/json

Request body for querying order status. At least one of prepayId or merchantTradeNo must be provided.

​
prepayId
string

Prepay ID.

​
merchantTradeNo
string

Merchant order ID. Either the prepay ID or this ID parameter must be provided.

Response

200 - application/json

Order detail

Response body for querying order status.

​
status
string
required

SUCCESS or FAIL

​
code
string
required

Error code

​
errorMessage
string

Error message, if any

​
data
object

Payment order information