跳转到主要内容
GET
/
open
/
v1
/
plan
/
list
cURL
curl --request GET \
  --url http://sandbox.mintlify.com/open/v1/plan/list \
  --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 '
{
  "merchantId": "M123456"
}
'
{
  "code": "0",
  "message": "",
  "data": {
    "total": 1,
    "list": [
      {
        "merchantPlanNo": "plan031004",
        "planNo": "63784847096545341",
        "planName": "计划01",
        "planDesc": "计划描述01",
        "productName": "2",
        "productNo": "2",
        "priceNo": "3",
        "priceName": "每周",
        "cryptoCurrency": "USDT",
        "cryptoAmount": "5",
        "period": "WEEK",
        "planStatus": "on",
        "createTime": 1773107374000,
        "updateTime": 1773107374000
      }
    ]
  },
  "success": true
}

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID,在 GatePay 平台申请获得

示例:

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

X-GatePay-Signature
string
必填

HMAC-SHA256签名,用于验证请求合法性

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
必填

时间戳(毫秒),与服务器时间差不能超过5分钟

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数,用于防止重放攻击

示例:

"9578"

请求体

application/json

查询订阅计划列表参数

merchantId
string
必填

商户编号

示例:

"M123456"

planStatus
enum<string>

订阅计划状态筛选

可用选项:
ACTIVE,
INACTIVE
示例:

"ACTIVE"

productNo
string

产品编号筛选

示例:

"PROD_ABC123"

page
integer<int32>
默认值:0

页码,从 0 开始,默认 0

必填范围: x >= 0
示例:

0

count
integer<int32>
默认值:10

每页数量,最大 100,默认 10

必填范围: 1 <= x <= 100
示例:

10

响应

200 - application/json

查询订阅计划列表成功

code
string

响应码,0 表示成功

示例:

"0"

message
string

响应描述,成功时为空

示例:

""

success
boolean

请求是否成功

示例:

true

data
object

响应数据