开发
API
自2022年9月6日起,本文档站不再更新内容,相关文档已迁移至全新“抖音开放平台”前往

退款结果查询

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

请求URL

https://developer.toutiao.com/api/apps/ecpay/v1/query_refund

请求方式

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

签名,详见地址

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

抖音退款单号

7067470744111892000

cp_extra

string

2048

开发者自定义字段,回调原样回传

一些附加信息

msg

string

256

退款错误描述

系统繁忙,参数错误等

{
  "err_no": 0,
  "err_tips": "",
  "refundInfo": {
    "refund_no": "7067470744111892000",
    "refund_amount": 190,
    "refund_status": "SUCCESS",
    "refunded_at": 1645523798,
    "is_all_settled": true,
    "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

内部异常

当前请求的退款可能成功也可能失败。 1、请使用相同的参数再次重试调用,需要保证退款请求号和退款金额不能变更。如果前一次退款请求已经处理成功,接口会幂等返回成功;如果前一次退款请求没有成功,接口会重试执行退款操作; 2、或者通过退款查询接口查询退款执行结果

1001

业务繁忙,请稍后重试

请降低频率后重试

2008

签名校验异常,请使用正确的签名

请使用正确的签名重新请求

2010

参数错误

请检查参数后重试

2042

小程序appid无效,请检查app_id字段

检查app_id字段信息是否有误

2047


服务商id无效,请检查thirdparty_id字段

检查thirdparty_id字段信息是否有误

2048

未查询到服务商与小程序的授权关系

检查服务商与小程序的授权关系

3101

退款记录不存在

检查请求中的退款单号正确,确认后重新发起

点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助