Skip to main content
POST
创建订阅订单

概述

本页说明 POST /pay-subscription/open/institution/v1/order/create 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。

说明

  • 认证方式使用 GatePay 标准签名请求头。
  • 本页展示同一接口的机构路径版本。
  • 除创建子账户、查询子账户详情、分页查询子账户外,机构侧请求需携带 X-GatePay-On-Behalf-Of
  • 通用签名规则请参见 /api-reference/version/100/cn/common/securityAndSignature

请求头

X-GatePay-Certificate-ClientId
string
必填

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

示例:

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

X-GatePay-Signature
string
必填

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

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
必填

毫秒级时间戳,与服务端时间偏差不得超过30秒

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

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

示例:

"9578"

X-GatePay-On-Behalf-Of
string
必填

必填代理归属请求头。请填写本次请求的发起方账户 ID;在机构代理商户 API 中通常填写目标子账户 ID,在机构代扣与划转接口中可填写机构账户 ID 或子账户 ID。

请求体

application/json

创建订阅单入参

merchantSubscriptionOrderNo
string
必填

商户订阅订单编号,商户全局唯一标识

示例:

"MSUB_20240312_001"

merchantPlanNo
string
必填

商户订阅计划编号(与planNo任选一个)

示例:

"MPLAN_20240101_001"

planNo
string

平台订阅计划编号(与merchantPlanNo任选一个)

示例:

"PLAN_ABC123"

callbackUrl
string

订阅成功后跳转的页面URL,长度不超过128字节

Maximum string length: 128
示例:

"https://www.example.com/subscription/success"

merchantUserId
string

商户侧用户唯一标识(法币 / Stripe 场景必填)

示例:

"user_10001"

email
string

客户邮箱,用于创建 Stripe Customer

Maximum string length: 128
示例:

"customer@example.com"

mode
enum<string>

收银台类型:embedded 为嵌入式收银台,hosted 为托管收银台;不传时按托管收银台处理

可用选项:
embedded,
hosted
示例:

"hosted"

响应

200 - application/json

创建订阅单成功

code
string

响应码,0 表示成功

示例:

"0"

message
string

响应描述,成功时为空

示例:

""

success
boolean

请求是否成功

示例:

true

data
object

响应数据