Skip to main content
GET
/
open
/
institution
/
v1
/
deduction
/
order
/
detail
Query Deduction Order Detail
curl --request GET \
  --url https://openplatform.gateapi.io/pay-subscription/open/institution/v1/deduction/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": "70778338049917032",
    "merchantSubscriptionOrderNo": "rhys-81",
    "planNo": "70778338049916930",
    "paymentOrderNo": "70778338049917033",
    "txHash": "0x658d3a403a4d6879dfd94229270a13e04249b50020ead15f6b7dceeb11286aee",
    "merchantId": "10002",
    "cryptoCurrency": "USDT",
    "chain": "BSC",
    "userAddress": "0xbe6D780C23E77D979Fad5FbEa249a44E5cAC0463",
    "merchantAddress": "0xeEfAe46E6551E54879C80C16882f745c25361473",
    "cryptoAmount": "0.01000000",
    "isDiscounted": false,
    "authorizeWalletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb0",
    "merchantDeductNo": "",
    "description": null,
    "errMsg": "",
    "payTime": 1773989575000,
    "payStatus": "SUCCESS",
    "totalFeeAmount": "0",
    "totalSettleAmount": "",
    "payDetails": []
  },
  "success": true
}

​
Overview

This page documents the GET /open/institution/v1/deduction/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

​
paymentOrderNo
string

Order number for subscription deduction At least one of paymentOrderNo or merchantDeductNo is required

​
merchantDeductNo
string

Merchant deduction reference (choose one with paymentOrderNo) At least one of paymentOrderNo or merchantDeductNo is required

Response

200 - application/json

Query deduction 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

Response data