退款结果查询
收藏
我的收藏

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

使用限制

无

接口说明

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

基本信息

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

HTTP URL

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

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

HTTP Method

POST

接口频次

30QPS(小程序app_id维度)

请求头

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

请求参数

名称	类型	是否必填	最大长度	描述	示例值
app_id	string	是	64	小程序APPID	tt07e3715e98c9aac0
out_refund_no	string	是	64	商户退款单号	out_refund_0
sign	string	是	344	签名，详见签名DEMO	74ee89952aed606de6f2a08d0bc54c0b
thirdparty_id	string	条件选填	64	第三方平台服务商id，服务商模式接入必传，非服务商模式留空	tta4bad2073b900000

请求示例

{
  "out_refund_no": "out_refund_0",
  "app_id": "tt07e3715e98c9aac0",
  "sign": "74ee89952aed606de6f2a08d0bc54c0b"
}

响应参数

公共响应参数

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

业务响应参数

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

refundinfo 参数

名称	类型	是否必填	最大长度	描述	示例值
refund_amount	number	是	[1,99999999999]	退款金额，单位为分	100，即1元
refund_status	string	是	-	退款状态枚举： SUCCESS：成功 FAIL：失败 PROCESSING：处理中	SUCCESS
refunded_at	number	是	10	退款时间，Unix 时间戳，10 位，整型数，秒级	1645523959
is_all_settled	boolean	是	-	退款账户枚举： TRUE：分账后退款，现金户出款 FALSE：分账前退款，在途户出款	TRUE
refund_no	string	是	64	抖音退款单号	N7067470744111892000
cp_extra	string	否	2048	开发者自定义字段，回调原样回传	一些附加信息
msg	string	否	256	退款错误描述	系统繁忙，参数错误等

响应示例

正常响应示例

{
  "err_no": 0,
  "err_tips": "",
  "refundInfo": {
    "refund_no": "N7067470744111892000",
    "refund_amount": 190,
    "refund_status": "SUCCESS",
    "refunded_at": 1645523798,
    "is_all_settled": false,
    "cp_extra": "",
    "msg": ""
  }
}

异常响应示例

{
  "err_no": 3101,
  "err_tips": "退款记录不存在",
  "refundInfo": {
    "refund_no": "",
    "refund_amount": 0,
    "refund_status": "",
    "refunded_at": 0,
    "is_all_settled": true,
    "cp_extra": "",
    "msg": ""
  }
}

错误码

错误码 err_no	描述 err_tips	排查建议
0	成功
1000	内部异常	系统异常，请稍后重试
1001	业务繁忙，请稍后重试	请降低频率后重试
2008	签名校验异常，请使用正确的签名	请检查签名参数，详见签名DEMO
2010	参数错误	请检查参数后重试
2042	小程序appid无效，请检查app_id字段	检查app_id字段信息是否有误
2047	服务商id无效，请检查thirdparty_id字段	检查thirdparty_id字段信息是否有误
2048	未查询到服务商与小程序的授权关系	检查服务商与小程序的授权关系
3101	退款记录不存在	检查请求中的退款单号正确，确认后重新发起

下一篇：小程序文档指引

退款结果查询收藏我的收藏