Skip to main content
POST
/
merchant
/
open
/
v1
/
pay
/
merchant
/
product
/
pageQuery
Query Product List
curl --request POST \
  --url https://openplatform.gateapi.io/merchant/open/v1/pay/merchant/product/pageQuery \
  --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 '
{
  "pageNo": 1,
  "pageSize": 10
}
'
{
  "success": "true",
  "code": "0",
  "message": "",
  "data": {
    "total": 1,
    "list": [
      {
        "merchantProductNo": "MTDC123",
        "productNo": "82973642140155927",
        "productName": "Meituan Bike",
        "productDesc": "Meituan Bike Membership",
        "productLogo": "https://s3.ap-northeast-1.amazonaws.com/gimg.gateimg.com/image/1627288/fe48d444c1943d65fb0125d766a7124d277f52d7112eebe6df47e321bafda073.jpg",
        "status": "ACTIVE",
        "createTime": 1774853409437,
        "updateTime": 1774853409437,
        "priceList": [
          {
            "merchantPriceNo": "MTDC_1123",
            "priceNo": "82973642140155928",
            "productNo": "82973642140155927",
            "priceName": "Monthly Plan",
            "priceDesc": "Monthly",
            "priceType": "FIX_AMOUNT",
            "payChannels": [
              {
                "channel": "GATEPAY",
                "status": "ACTIVE"
              }
            ],
            "amountType": "fiat",
            "cryptoCurrency": "",
            "cryptoAmount": null,
            "fiatCurrency": "USD",
            "fiatAmount": 10,
            "period": "MONTH",
            "interval": 1,
            "promoConfigType": "NONE",
            "promoAmount": null,
            "promoRate": null,
            "status": "ACTIVE",
            "createTime": 1774853409437,
            "updateTime": 1774853409437
          }
        ]
      }
    ]
  }
}

​
Overview

This page documents the POST /merchant/open/v1/pay/merchant/product/pageQuery 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"

Body

application/json

Query product list request parameters

​
pageNo
integer<int32>
required

Page number

Example:

1

​
pageSize
integer<int32>
required

Page size

Example:

10

Response

200 - application/json

Query product list successful

​
code
string

Response code, "0" for success

Example:

"0"

​
message
string

Return error reason on failure

Example:

""

​
success
string

true (success) / false (failure)

Example:

"true"

​
data
object

Paginated query results