查询账单
查询扣款账单。查询条件三选一且互斥(恰好传一个):deduction_no / subscription_no / out_trade_no。成功时业务体为账单数组;退款前可用本接口取得 deduction_no。
接口说明
请求方式:【POST】/v1/subscription/deduction/query
请求域名:【主域名】https://api.baofu.com
请求参数
Header 参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | true | 请参考【开发指引-整体说明】生成认证信息 |
| Accept | string | true | 请设置为 application/json |
| Content-Type | string | true | 请设置为 application/json |
Body 参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| deduction_no | string(64) | false | 【账单号】与另两键至少填一个;都填时优先本字段精确查单条 |
| subscription_no | string(64) | false | 【订阅号】与另两键至少填一个;无账单号时优先按本字段返回该订阅下账单列表 |
| out_trade_no | string(64) | false | 【商户签约订单号】与另两键至少填一个;仅本字段时按订单映射解析订阅后再查账单列表 |
请求示例
{
"deduction_no": "DD01010120260319120000000001"
}
请求示例
{
"subscription_no": "SP01010120260319120000000001"
}
请求示例
{
"out_trade_no": "MCH_OUT_20260319120001"
}
应答参数
200 OK
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| deduction_no | string | true | 账单号 |
| subscription_no | string | true | 订阅号 |
| original_amount | integer | true | 原始应扣金额(分) |
| actual_amount | integer | true | 实际扣款金额(分) |
| deduct_period | integer | true | 扣款期数 |
| trade_status | string | true | 交易状态,取值:PENDING / PROCESSING / CHANNEL_PENDING / SUCCESS / FAILED / CANCELLED |
| retry_count | integer | true | 已重试次数 |
| channel_order_no | string | false | 渠道订单号(可空) |
| error_code | string | false | 不下发(恒省略/null);码只认统一网关外层 HTTP |
| error_message | string | false | 失败时有值(中文原因);成功为 null/省略 |
| deduction_time | string | false | 扣款完成时间,ISO 8601(可空) |
| create_time | string | true | 创建时间,ISO 8601 |
应答示例
200 OK
[
{
"deduction_no": "DD01010120260319120000000001",
"subscription_no": "SP01010120260319120000000001",
"original_amount": 1990,
"actual_amount": 1592,
"deduct_period": 3,
"trade_status": "SUCCESS",
"retry_count": 0,
"channel_order_no": "CH2026031912000001",
"deduction_time": "2026-06-19T10:00:01+08:00",
"create_time": "2026-06-19T10:00:00+08:00"
}
]
错误码
公共错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 参数校验失败 | 必填参数缺失或格式不合法 |
| 401 | SIGN_ERROR | 验证不通过 | 请参阅【开发指引-整体说明】排查签名 |
| 500 | SYSTEM_ERROR | 系统异常 | 内部系统错误 |
业务错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 404 | ORDER_NOT_FOUND | 查询对象不存在 | 无匹配账单(含商户订单号查不到关联订阅) |
| 404 | MCH_NOT_EXISTS | 商户号不匹配 | 传入的 merchantNo 与订阅归属不一致 |
应答示例
失败
{
"code": "ORDER_NOT_FOUND",
"message": "扣款单不存在"
}