可分账余额查询
收藏
分账余额查询用于查询一笔支付单在途资金的商户可支配金额（即如果该笔订单分账时平台会扣费，则会返回扣费或退款后的可分账金额）。
使用限制
无
基本信息
基本信息 | |
|---|---|
HTTP URL | https://developer.toutiao.com/api/apps/ecpay/v1/unsettle_amount |
HTTP Method | POST |
接口频次 | 60QPS(小程序 app_id 维度) |
请求头
名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
Content-Type | string | 是 | 固定值 "application/json" |
请求参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
app_id | string | 是 | 64 | 小程序APPID | tt07e3715e982xaac0 |
thirdparty_id | string | 条件选填 | 64 | 第三方平台服务商 id，服务商模式接入必传，非服务商模式留空 | tte76091dd784a4a33 |
out_order_no | string | 是 | 64 | 商户侧支付单号 | out7101994117563058470 |
out_item_order_no | string | 否 | 64 | 商户侧支付子单单号 | out71019941175630584701 |
sign | string | 是 | 344 | 签名，详见地址 | d98e6af1c490b36f7b72e2037f81a511 |
请求示例
{ "out_order_no": "out7101994117563058470", "app_id": "tt07e3715e98c9aac0", "sign": "d98e6af1c490b36f7b72e2037f81a511" }
响应参数
公共响应参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
err_no | number | 是 | - | 详见错误码 | 0 |
err_tips | string | 是 | - | 详见错误描述 | success |
data | object | 条件选填 | - | err_no=0时必填 |
业务响应参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
out_order_no | string | 是 | 64 | 商户侧的订单号，请求参数原样返回 | out7101994117563058470 |
unsettle_amount | number | 是 | 取值范围[1,10000000000] | 剩余待结算金额，单位为分 | 100 |
detail | object | 条件选填 | - | 订单动账信息(详见下方参数信息) |
detail 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
pay_info | object | 是 | - | 支付单信息(详见下方pay_info参数) | |
refund_info | array | 条件选填 | - | 退款单信息(详见下方refund_info参数，存在退款有效单才会有值) | |
payment_rake | number | 是 | 取值范围[1,10000000000] | 平台支付手续费金额，单位为分 | 6 |
life_rake | number | 是 | 取值范围[1,10000000000] | 平台行业抽佣金额，单位为分 | 50 |
commission | number | 是 | 取值范围[1,10000000000] | 平台达人分佣金额，单位为分 | 50 |
pay_info 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
out_order_no | string | 是 | 64 | 外部支付单单号 | 2022101400001 |
amount | number | 是 | 取值范围[1,10000000000] | 支付单总金额 | 2000 |
refund_info 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
out_refund_no | string | 是 | 64 | 外部退款单单号 | R_2022101400001 |
amount | number | 是 | 取值范围[1,10000000000] | 退款单总金额 | 1000 |
响应示例
正常响应示例
{ "err_no": 0, "err_tips": "success", "data": { "out_order_no": "out7101994117563058470", "unsettle_amount": 1000, "detail": { "pay_info": { "out_order_no": "2022101400001", "amount": 2000 }, "refund_info": [ { "out_refund_no": "R_2022101400001", "amount": 1000 } ], "payment_rake": 6, "life_rake": 50, "commission": 50 } } }
异常响应示例
{ "err_no": 2000, "err_tips": "单号记录不存在", "data": { "out_order_no": "", "unsettle_amount": 0, "detail": null } }
错误码
错误码err_no | 描述 | 排查建议 |
|---|---|---|
0 | success | 成功 |
1000 | 系统异常，请原单号重试 | 服务内部异常，请稍后重试 |
1001 | 业务繁忙，请稍后重试 | 限流（单app_id维度限流60qps），请在业务低峰期后原参数重试 |
1004 | 网络不稳定，请稍后重试 | 网络不稳定，请稍后重试 |
2000 | 单号记录不存在 | 传入的外部支付单号out_order_no查无对应支付单，检查并调整参数后重试 |
2010 | 业务参数处理异常 | 请检查参数后重试（是否缺少必填参数，参数是否合法等） |
6002 | 原支付单未支付成功，禁止分账余额查询 | 原支付单未支付成功并核销，禁止分账余额查询 |
