Skip to main content
POST
/
merchant
/
open
/
institution
/
v1
/
pay
/
merchant
/
product
/
queryOne
Query Product Detail
curl --request POST \
  --url https://openplatform.gateapi.io/merchant/open/institution/v1/pay/merchant/product/queryOne \
  --header 'Content-Type: application/json' \
  --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>' \
  --data '
{
  "merchantProductNo": "70778357377269765"
}
'
{
  "success": "true",
  "code": "0",
  "message": "",
  "data": {
    "merchantProductNo": "QJDC",
    "productNo": "70778357377269765",
    "productName": "Qingju Bike",
    "productDesc": "Qingju Bike Membership",
    "productLogo": "https://s3.ap-northeast-1.amazonaws.com/gimg.gateimg.com/image/1627288/fe48d444c1943d65fb0125d766a7124d277f52d7112eebe6df47e321bafda073.jpg",
    "status": "ACTIVE",
    "createTime": 1773988434402,
    "updateTime": 1773988434402,
    "priceList": [
      {
        "merchantPriceNo": "QJDC_1",
        "priceNo": "70778357377269766",
        "productNo": "70778357377269765",
        "priceName": "Monthly Plan",
        "priceDesc": "Monthly",
        "priceType": "FIX_AMOUNT",
        "payChannels": [
          {
            "channel": "GATEPAY",
            "status": "ACTIVE"
          }
        ],
        "amountType": "crypto",
        "cryptoCurrency": "USDT",
        "cryptoAmount": 0.01,
        "fiatCurrency": "",
        "fiatAmount": null,
        "period": "MONTH",
        "interval": 2,
        "promoConfigType": "NONE",
        "promoAmount": null,
        "promoRate": null,
        "status": "ACTIVE",
        "createTime": 1773988434402,
        "updateTime": 1773988434402
      }
    ]
  }
}

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 /merchant/open/institution/v1/pay/merchant/product/queryOne 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.

Body

application/json

Query product details request parameters

​
merchantProductNo
string
required

Product code

Example:

"MPROD_20240312_001"

Response

200 - application/json

Query product details successful

​
code
string

Response code, success is "0"

Example:

"0"

​
message
string

Error reason returned on failure

Example:

""

​
success
string

true (success) / false (failure)

Example:

"true"

​
data
object

Product information