查询分账回退结果
收藏
我的收藏

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

使用限制

无

使用说明

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

基本信息

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

HTTP URL

正式环境： https://developer.toutiao.com/api/apps/ecpay/v1/query_return

沙盒环境： https://open-sandbox.douyin.com/api/apps/ecpay/v1/query_return

HTTP Method

POST

接口频次

50QPS(小程序 app_id 维度)

请求头

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

请求参数

名称	类型	是否必填	最大长度	字段描述	示例值
app_id	string	是	64	小程序APPID	tt07e3715e98c9aac0
thirdparty_id	string	条件选填	64	第三方平台服务商id，服务商模式接入必传，非服务商模式留空	tta4bad2073b900000
return_no	string	是	64	小程序回退单号	N7069590250007333000
out_return_no	string	是	64	开发者回退单号	7056505317450041644
sign	string	是	344	签名，详见签名DEMO	d98e6af1c490b36f7b72e2037f81a511

请求示例

{
  "app_id": "tt07e3715e98c9aac0",
  "return_no": "N7069590250007333000",
  "out_return_no": "7067781639492913452",
  "sign": "d98e6af1c490b36f7b72e2037f81a511",
  "thirdparty_id": "tta4bad2073b900000"
}

响应参数

公共响应参数

名称	类型	是否必填	最大长度	字段描述	示例值
err_no	number	是	-	详见错误码	0
err_tips	string	是	-	详见错误提示信息	成功

业务响应参数

名称	类型	是否必填	最大长度	字段描述	示例值
return_info	returnInfo	否	-	分账回退基本信息	-

其中 return_info 包含如下的字段：

名称	类型	是否必填	最大长度	字段描述	示例
app_id	string	是	64	小程序APPID	tt07e3715e98c9aac0
settle_no	string	是	64	平台分账单号	N7067781639492913452
out_settle_no	string	是	64	商户分账单号	test_settle_2004
out_return_no	string	是	64	商户回退单号	7056505317450041644
merchant_uid	string	是	32	回退商户号	XCXP_000003089
amount	number	是	[1,99999999999]	回退金额	100，即1元
return_no	string	是	64	平台回退单号	N7069590250007333000
return_status	string	是	-	回退状态枚举值： SUCCESS：成功 FAIL：失败 PROCESSING：处理中注意：如果返回为处理中，请勿变更商户回退单号，使用相同的参数再次发起分账回退，否则会出现资金风险在处理中状态的回退单如果5天没有成功，会因为超时被设置为已失败	SUCCESS
fail_reason	string	否	100	回退失败的原因，此字段仅回退结果为FAIL时存在	退分账记录不存在
finish_time	number	是	10	回退完成时间，Unix 时间戳，10 位，整型数，秒级	1644399124

响应示例

正常响应示例

{
  "err_no": 0,
  "err_tips": "",
  "return_info": {
    "app_id": "ttcfdbb96650e33350",
    "thirdparty_id": "",
    "settle_no": "N71518187993000002",
    "out_settle_no": "ot_settle_70676827429425800001",
    "out_return_no": "ot_return_70221010170428222101",
    "merchant_uid": "M695122614767700001",
    "return_amount": 10,
    "return_status": "SUCCESS",
    "return_no": "N7075228873218090001",
    "fail_reason": "SUCCESS",
    "finish_time": 1647332403,
    "cp_extra": ""
  }
}

异常响应示例

{
  "err_no": 2020,
  "err_tips": "非法app_id",
  "return_info": null
}

错误码

错误码err_no	描述	排查建议
0	success
1000	系统异常，请原单号重试	业务异常，请稍后使用原请求重试
2020	非法app_id	请检查请求参数然后重试
2102	回退单号长度必须在0-64之间	修改回退单号out_return_no后重试
4408	退分账记录不存在	检查传入的回退单号out_return_no或return_no是否正确

下一篇：小程序文档指引

查询分账回退结果收藏我的收藏