Skip to main content
GET
/
open
/
institution
/
v1
/
order
/
detail
Query Subscription Order Detail
curl --request GET \
  --url https://openplatform.gateapi.io/pay-subscription/open/institution/v1/order/detail \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "code": "0",
  "message": "",
  "data": {
    "subscriptionOrderNo": "63812942625112175",
    "merchantSubscriptionOrderNo": "rhys-60",
    "subscriptionLink": "https://119.28.35.132:13555/zh/web3-subscribe?subscriptionOrderNo=63812942625112175",
    "planNo": "2033844612305932301",
    "planName": "plan031701 fiat currency with trial period no discount",
    "planDesc": "Plan Description 01",
    "merchantId": "10002",
    "productNo": "3",
    "productName": "Youku",
    "priceNo": "7",
    "priceName": "Daily",
    "cryptoCurrency": "USDT",
    "chain": "BSC",
    "userAddress": "0xbe6D780C23E77D979Fad5FbEa249a44E5cAC0463",
    "userId": 10086001,
    "authorizedAmount": "31.95",
    "cryptoAmount": "0.10026792",
    "paidCount": 0,
    "totalPaidAmount": "0",
    "period": "DAY",
    "interval": 1,
    "totalPayCount": 2,
    "trialDays": 3,
    "endTime": 0,
    "lastPayTime": 0,
    "promoAmount": "0",
    "promoRate": "0",
    "nextPayTime": 0,
    "callbackUrl": "https://gate.com",
    "orderStatus": "TRIAL",
    "createTime": 1773921305887,
    "updateTime": 1773893750000,
    "priceType": "FIX_AMOUNT",
    "paymentChannel": "GATEPAY",
    "authTime": 1773921306000
  },
  "success": true
}

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 GET /open/institution/v1/order/detail endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform application

Example:

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

​
X-GatePay-Signature
string
required

HMAC-SHA256 signature, used to verify request legitimacy

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

​
X-GatePay-Timestamp
string
required

Timestamp (milliseconds), time difference with server cannot exceed 5 minutes

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random number, used to prevent replay attacks

Example:

"9578"

​
X-GatePay-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Query Parameters

​
subscriptionOrderNo
string

Subscription order number (choose one with merchantSubscriptionOrderNo)

Example:

"PLAN_20240101_001"

​
merchantSubscriptionOrderNo
string

Merchant subscription order number (choose one with subscriptionOrderNo)

Example:

"PRICE_ABC123"

Response

200 - application/json

Query subscription order details successful

​
code
string

Response code, 0 indicates success

Example:

"0"

​
message
string

Response description, empty when successful

Example:

""

​
success
boolean

Whether the request was successful

Example:

true

​
data
object