查询 - 订阅主单查询 query

请求地址

https://{{gateway_domain}}/pg/v2/payment/subscription/query

请求参数

HTTP Method

POST

HTTP Header

字段	数据类型	长度限制	是否必填项	说明
Content-Type	String	N/A	是	字段值只支持 application/json
Accept	String	N/A	是	字段值只支持 application/json
Authorization	String		是	Authorization: {type} {credentials}，详情参考签名规范部分

HTTP Body

字段	数据类型	长度限制	是否必填项	说明
merchantSubscriptionNo	String	50	merchantSubscriptionNo, subscriptionNo 二选一	商户订阅号
subscriptionNo	String	32	merchantSubscriptionNo, subscriptionNo 二选一	平台订阅号

响应结果

HTTP Header

字段	数据类型	是否必填项	说明
Content-Type	String	是	字段值只支持 application/json
Authorization	String	是	Authorization: {type} {credentials}，详情参考签名规范部分

HTTP Body

字段	数据类型	是否必填项	说明
code	String	是
message
data	JSON Object

data 字段说明

字段	数据类型	说明
subscription	JSON Object	订阅主单数据
currentCycle	JSON Object	当前周期数据

• subscription 参数结构说明

字段	数据类型	说明
subscriptionNo	String	支付平台订阅号
merchantSubscriptionNo	String	商户生成的订阅号
status	String	订阅主单状态
merchantAttach	String	支付请求时，如使用此字段，支付平台则返回
createdTime	String	订阅创建时间

• currentCycle 参数结构说明
  • 这个值只会在事件为SUBSCRIPTION.ACTIVATED和SUBSCRIPTION.CHARGED有值

字段	数据类型	说明
status	String	订阅周期单单状态
cycleNo	String	一个周期唯一编码
paymentNo	String	支付平台交易流水号，对应原支付订单的流水号（试用期没有支付流水号）
amount	String	当前期订单金额
currency	String	当前期订单币种
cycleIndex	String	当前期数
rrn	String	渠道检索参考号码，依赖渠道返回
chargedTime	String	当前期订阅已扣费时间

示例

请求

curl https://{{gateway_domain}}/pg/v2/payment/subscription/query \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
 -d '{ 
  "merchantSubscriptionNo": "MSN-1162"
}'

响应

HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
        "subscription": {
          "status": "CHARGED",
          "subscriptionNo": "20240423221044300800001096000005",
          "merchantSubscriptionNo": "MSN-1162",
          "merchantAttach": null,
          "createdTime": "2024-04-23T22:10:45+08:00",
        },
        "currentCycle": {
          "status": "CHARGED",
          "cycleNo": "20240423221044300800001096000005",
          "amount": "1.00",
          "currency": "RUB",
          "cycleIndex": 2,
          "rrn": "1234567890",
          "chargeTime": "2025-04-23T22:10:45+08:00"
        }
    }
}

订阅主单状态

状态	说明
PENDING	等待用户签约付款
ACTIVATED	订阅已激活，表示用户首次订阅并完成首次支付
CHARGE_PENDING	每期新开始时会尝试扣款，在得到明确成功或者失败的结果前会处于这个状态
CHARGED	本期订阅成功
HALTED	扣款失败时进这个状态，由系统触发，可以回到CHARGE_PENDING和CHARGED状态
CANCELLED	用户主动取消
CLOSED	用户主动退款或者系统推动