结算及分账结果查询
收藏
我的收藏

使用限制

无

接口说明

开发者/服务商可以通过接口主动查询分账订单状态。

沙盒环境使用说明详见担保支付-沙盒环境。

基本信息

基本信息
HTTP URL	正式环境： https://developer.toutiao.com/api/apps/ecpay/v1/query_settle 沙盒环境： https://open-sandbox.douyin.com/api/apps/ecpay/v1/query_settle
HTTP Method	POST
接口频次	50QPS(小程序app_id维度)

请求头

名称	类型	必填	描述
Content-Type	string	是	固定值 "application/json"

请求参数

名称	类型	是否必填	最大长度	描述	示例值
app_id	string	是	64	小程序APPID	tt07e3715e98c9aac0
out_settle_no	string	否	64	开发者侧分账订单号, 同一小程序下不可重复	out_settle_no_123123
sign	string	是	344	签名，详见签名DEMO	d17931f44e2de4aeb12a797fb8a4450d
thirdparty_id	string	条件选填	64	第三方平台服务商 id，非服务商模式留空	tt07e3715e98c9aac0

请求示例

json复制
{
  "sign": "d17931f44e2de4aeb12a797fb8a4450d",
  "app_id": "tt07e3715e98c9aac0",
  "out_settle_no": "out_settle_no_123123",
  "thirdparty_id": "tt07e3715e98c9aac0"
}

响应参数

公共响应参数

名称	类型	是否必填	最大长度	描述	示例值
error_no	number	是	-	详见错误码	详见错误码
error_tips	string	是	-	详见错误描述	详见错误描述

业务响应参数

名称	类型	是否必填	最大长度	描述	示例值
settle_info	object	否	-	结构体见下

SettleInfo 参数

名称	类型	是否必填	最大长度	描述	示例值
settle_no	string	是	128	平台侧分账单号	N7067424934460492047
settle_amount	number	是	[1,99999999999]	分账金额，单位为分	101
settle_status	string	是	-	分账状态枚举值： SUCCESS：成功 FAIL：失败 PROCESSING：处理中	SUCCESS
settle_detail	string	是	1024	具体分账详情	商户号6891537072713100000-分成金额(分)100
settled_at	number	是	10	分账成功时间戳，否则为0	1645513202
rake	number	是	[1,99999999999]	技术服务费金额 + 商户与平台约定的抽佣金额，单位为分	0
commission	number	是	[1,99999999999]	达人抽佣金额，单位为分	1
cp_extra	string	是	2048	开发者自定义字段，回调原样回传	52fff5f7a4bf4a921c2daf83c
msg	string	是	256	可能存在的失败原因	分账金额超限

响应示例

正常示例

json复制
{
  "err_no": 0,
  "err_tips": "受理成功",
  "settle_info": {
    "settle_no": "N7067424934460492047",
    "settle_amount": 101,
    "settle_status": "SUCCESS",
    "settle_detail": "商户号6891537072713100000-分成金额(分)100",
    "settled_at": 1645513202,
    "rake": 0,
    "commission": 1,
    "cp_extra": "52fff5f7a4bf4a921c2daf83c",
    "msg": "分账金额超限"
  }
}

异常示例

json复制
{
  "err_no": 2000,
  "err_tips": "单号记录不存在",
  "settle_info": {
    "settle_no": "",
    "settle_amount": 0,
    "settle_status": "",
    "settle_detail": "",
    "settled_at": 0,
    "rake": 0,
    "commission": 0,
    "cp_extra": "",
    "msg": ""
  }
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	0	业务成功	具体分账状态等信息以结构体中为准
200	1000	内部异常	业务异常，请稍后使用原请求重试
200	1002	数据异常，请检查必传参数与单号是否正确	业务异常，请稍后使用原请求重试
200	2000	单号记录不存在	请检查参数后重试
200	2008	验签异常	请检查参数，详见签名DEMO
200	2010	业务参数处理异常	请检查参数后重试
200	2020	非法app_id	请检查参数中的app_id是否有效
200	2033	结算号为空	请检查参数，调整外部分账单号后重试
200	2000	单号记录不存在	请检查参数，传入的外部分账单号无对应分账订单