Skip to main content
GET
Checkout Order Details

Overview

This page documents the GET /payment/open/institution/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 institutional path version of the same endpoint.
  • Provide at least one of prepayId or merchantTradeNo.
  • 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.
  • 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.

Institution Notes

  • Institutional requests must include X-GatePay-On-Behalf-Of to specify the institutional sub-account to operate on.

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

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

Example:

"1672905655498"

X-GatePay-Nonce
string
required

Random nonce for replay attack prevention

Example:

"9578"

Query Parameters

prepayId
string

Pre-order ID (either prepayId or merchantTradeNo required)

merchantTradeNo
string

Merchant order number (either prepayId or merchantTradeNo required)

Response

200 - application/json

Order details retrieved successfully

status
string

Payment status

code
string

Error code

errorMessage
string

Error message

data
object

Checkout order details