Skip to main content
POST
完成订阅订单

概述

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

说明

请求头

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"

请求体

application/json

订阅订单状态流转入参

operationType
enum<string>
必填

操作类型:FINISH(完成)/CANCEL(取消)

可用选项:
FINISH,
CANCEL
示例:

"FINISH"

subscriptionOrderNo
string

订阅订单编号(与merchantSubscriptionOrderNo任选一个)

示例:

"SUB_20240101_001"

merchantSubscriptionOrderNo
string

商户订阅订单编号(与subscriptionOrderNo任选一个)

示例:

"MSUB_20240101_001"

reason
string

操作原因,最多100字符

Maximum string length: 100
示例:

"用户主动取消订阅"

响应

200 - application/json

订阅订单状态流转成功

code
string

响应码,0 表示成功

示例:

"0"

message
string

响应描述,成功时为空

示例:

""

success
boolean

请求是否成功

示例:

true

data
object | null

响应数据

示例:

null