查询订阅

接口说明

适用场景:【订阅查询】根据订阅号或商户订单号查询订阅详情

请求方式:【POST】/v1/subscription/query

请求域名:【主域名】https://api.baofu.com

请求参数

Header HTTP头参数

Header 必填 说明
Authorization 统一网关鉴权;签名算法与签名参数见下表(须在一行内,勿换行)
Content-Type 固定 application/json

宝付要求请求通过HTTP Authorization头来传递签名。Authorization由认证类型和签名信息两个部分组成。

Authorization: 认证类型 签名信息

具体组成为:

  • 认证类型,取值 RSA/SM2

签名信息

参数名 说明
mch_id 宝付分配的唯一商编
app_id 宝付终端号,选填,若传值,则使用宝付4.0证书
nonce_str 请求随机串,和上面构造签名串的随机串要保持一致
timestamp 时间戳 和上面构造签名串的时间戳要保持一致
serial_no 商户API证书序列号,用于声明所使用的证书
baofu_serial_no 宝付证书序列号, 联系技术支持提供
dgtl_envlp 数字信封(非必填),16位密钥,用宝付公钥加密后传输
signature 签名值,上面算出来的签名值

注意:以上七项签名信息,无顺序要求。数字信封参数可以为空

Authorization头的示例如下:(注意,示例因为排版可能存在换行,实际数据应在一行)

Authorization: RSA mch_id="128308",app_id="128308",nonce_str="P7X2R9Z1M5W6Q4V3B8C0D2E1F7G9H2J4",signature="DKLJASKLFGHQWJFPWQJLFKGDKSLGJPQJPFWQJLGKNDLSKJGLDSJLKFSJAKL",timestamp="1507488238",serial_no="123821002",baofu_serial_no="123822342",dgtl_envlp="GLKUIOWQGKDLSNGLKQWJPRQ"

body 包体参数

subscriptionNo  与 outTradeNo 二选一 string(32)

【订阅号】内部订单号


outTradeNo  与 subscriptionNo 二选一 string(64)

【商户订单号】外部订单号


约束subscriptionNooutTradeNo恰好其一非空(trim 后),同时为空或同时非空均报错。

响应参数

成功时 data 为订阅视图对象,字段与签约成功响应一致:

subscriptionNo  string

【订阅号】


merchantNo  string

【商户号】可空


outTradeNo  string

【商户签约订单号】


productCode  string

【内部产品编码】


userId  string

【用户标识】


cycleType  string

【周期类型】见数据字典与枚举说明1.3


cycleValue  number

【周期值】


fixedDay  number

【固定扣款日】依周期模型


baseAmount  number

【每期扣款基准金额】单位:分。对应库表 base_amount;由产品配置、营销算价或变更接口 specifiedAmount 决定


appliedPricingType  string

【应用的定价类型】见数据字典与枚举说明1.6。如 MERCHANT_SPECIFIED 表示商户经变更接口指定金额、不经营销算价


status  string

【订阅状态】见数据字典与枚举说明1.1


signTime  string

【签约时间】


cancelTime  string

【取消时间】未取消时为 null


nextDeductionTime  string

【下次计划扣款时间】


currentPeriod  number

【当前期数】


totalPeriod  number

【总期数】null 为永续


错误码

状态码 错误码 描述 说明
400 PARAM_ERROR 参数校验失败 subscriptionNooutTradeNo 同时为空或同时非空
404 RESOURCE_NOT_EXISTS 订阅不存在 对应订阅记录不存在
500 SYSTEM_ERROR 系统异常 内部系统错误