发起退款
收藏接口说明
使用限制
接入前，请先查看接入前准备是否完成
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/trade_basic/v1/developer/refund_create/ |
| HTTP Method | POST |
| Scope | trade_basic.developer.trade_refund |
| 权限要求 | 无 |
请求参数
退款原因，可填多个，不超过10个
退款结果通知地址，必须是 HTTPS 类型， 长度 <= 512 byte 。若不填，则默认使用在解决方案配置-消息通知中指定的回调地址，配置方式参考解决方案配置文档
当订单未发生任何退款时，可设置refund_all=true，refund_total_amount=订单实付金额，发起整单退款。refund_all=true时不能设置item_order_detail
curl --location --request POST 'https://open.douyin.com/api/trade_basic/v1/developer/refund_create/' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "order_id": "motb123123131", "out_refund_no": "ext_123123", "cp_extra": "extra_info", "order_entry_schema": { "path": "page/xxx", "params": "{\"id\":1}" }, "refund_total_amount ":100, "notify_url": "https://xxx", "item_order_detail": [ { "item_order_id": "xxx", "refund_amount": 100 } ], "refund_reason":[{"code":101,"text":"不想要了"}] }'
响应参数
错误提示信息
状态码 0 代表业务处理成功，具体错误码参见后文错误码章节
日志id，排查问题时使用
{ "err_no": 0, "err_msg": "success", "log_id": "2022092115392201020812109511046", "data": { "refund_id": "motb7922312", "refund_audit_deadline": 151231321231 } }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28001005 | 系统内部错误，请重试 | 请求重试，若依然无解请向平台提交反馈 |
| 200 | 28001003 | access_token无效 | 重新请求生成access_token |
| 200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
| 200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
| 200 | 28001006 | 网络调用错误，请重试 | 重试即可 |
| 200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
| 200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
| 200 | 28003017 | quota已用完 | 联系平台处理 |
| 200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁，联系平台处理 |
| 200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
| 200 | 10000 | 参数不合法：xxx参数不合法/本接口不支持该类型订单发起退款/(ots72128388728472)商品单不存在 |
|
| 200 | 12001 | 操作过于频繁，请稍后再试 | 稍后再试 |
| 200 | 13000 | 系统错误，请重试 | 请重试，若多次重试仍然报错，请联系oncall |
| 200 | 20000 | 订单不存在 | 检查order_id是否正确，order_id与appid是否匹配，order_id与登录的用户是否匹配 |
| 200 | 22000 | 订单状态不支持退款 | 请检查订单状态：订单未支付不允许发起退款 |
| 200 | 22001 | 商品单(motb718283)状态xxx,不支持发起退款 | 商品单的状态是xxx，该状态下不允许发起退款 1. 退款中，需要等该笔退款完结后，才能再次发起 2. 履约中/已履约，请核对订单规则，确认此状态是否允许退款。 |
| 200 | 22002 | 无可退款的商品单 | 订单下所有的item处于不可退状态时，无法发起退款，参考22001的说明 |
| 200 | 22004 | 外部退款单号重复 | 开发者生成的外部退款单号以前已经用过了，请重新生成 |
| 200 | 22007 | 退款的商品总数量超限 | 退款item数量不能大于100个 |
| 200 | 22009 | 履约状态不同的商品单不能同时发起退款,请分别发起 | 商品单履约状态不一致，请分别发起(由于履约状态不一致的商品单资金状态可能不同，若同时发起可能导致卡单，所以建议分别发起) |
| 200 | 22012 | 退款来源不支持退款 | 退款来源有: 用户,开发者,抖音客服 |
| 200 | 22013 | 退款金额不能大于实付金额/商品单(motb71263537)退款金额超过可退金额/CPS(motb72128284)商品单退款金额必须>=实付金额*n% |
|
