查询支付订单

接口说明

适用场景:【扣款查询】根据扣款单号查询扣款单详情

请求方式:【POST】/v1/subscription/deduction/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 包体参数

deductionNo  必填 string(32)

【扣款单号】


响应参数

成功时 data 为扣款单视图对象:

deductionNo  string

【扣款单号】


subscriptionNo  string

【订阅号】


merchantNo  string

【商户号】可空


originalAmount  number

【原始应扣金额】单位:分。算价/策略应用后的应付基准


actualAmount  number

【实际扣款金额】单位:分。渠道成功扣收金额


periodNumber  number

【当前账单期数】


status  string

【扣款单状态】见数据字典与枚举说明1.2


retryCount  number

【已重试次数】


channelOrderNo  string

【渠道订单号】可空


failCode  string

【失败错误码】失败终态时有值


failMessage  string

【失败原因】失败终态时有值


deductionTime  string

【扣款完成时间】


createdAt  string

【创建时间】


错误码

状态码 错误码 描述 说明
400 PARAM_ERROR 参数校验失败 扣款单号缺失或格式不合法
404 RESOURCE_NOT_EXISTS 扣款单不存在 对应扣款单记录不存在
500 SYSTEM_ERROR 系统异常 内部系统错误