订阅签约

订阅签约

接口说明

适用场景：商户发起订阅签约，含首期扣款或试用鉴权

请求方式：【POST】/v1/subscription/sign

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

请求参数

Header　HTTP头参数

详细请参考【开发指引-整体说明】

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

Authorization: 认证类型 签名信息

具体组成为：

• 认证类型，取值 RSA/SM2

签名信息

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

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　包体参数

outTradeNo 　必填　string(64)

【商户侧订单号】与统一会员组成签约幂等键。6-64个字符，只能是数字、大小写字母

productCode 　必填　string(32)

【内部产品编码】配置中心维护的产品编码

userId 　视产品　string(64)

【用户标识】部分产品必填

riskItem 　必填　string(2048)

【风控扩展】JSON 字符串（内部 JSON 需转义）；详细参数见风控参数字段说明（通用参数、电商、互金消金、航旅、酒店、保险、游戏、大宗）；透传至协议支付，具体字段以运营对接为准

deductionPayRoute 　必填　array[object]

【扣款路径】至少一档，每档含 order、paymentMethod、subjectRef

注意：deductionPayRoute 为 JSON 数组类型，直接传 JSON 数组即可，无需做字符串转义；riskItem 仍为 String 类型，值为 JSON 字符串，必须对内部 JSON 做转义处理。

notifyUrl 　视业务　string(512)

【异步通知地址】须以 http:// 或 https:// 开头；用于接收异步回调通知

merchantNo 　选填　string(32)

【商户号】可省略，以统一会员反查为准

clientIp 　选填　string(128)

【客户端IP】网关未解析到 IP 时可兜底，与订阅落库 client_ip 一致

响应参数

成功时 data 为订阅视图对象：

subscriptionNo 　string

【订阅号】系统分配的订阅唯一标识

merchantNo 　string

【商户号】可空

outTradeNo 　string

【商户签约订单号】与请求中 outTradeNo 一致

productCode 　string

【内部产品编码】

userId 　string

【用户标识】

cycleType 　string

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

cycleValue 　number

【周期值】

fixedDay 　number

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

baseAmount 　number

【每期扣款基准金额】单位：分。与产品配置或营销算价结果一致

appliedPricingType 　string

【应用的定价类型】枚举码，见数据字典与枚举说明1.6

status 　string

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

signTime 　string

【签约时间】

cancelTime 　string

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

nextDeductionTime 　string

【下次计划扣款时间】

currentPeriod 　number

【当前期数】

totalPeriod 　number

【总期数】null 为永续

错误码