发起退款
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
https://open.douyin.com/api/trade_basic/v1/developer/refund_create/
使用限制
接口说明
请求头
错误码
| 错误码 | 错误提示 | 建议解决方案 |
|---|---|---|
| 10000 | 参数不合法：xxx参数不合法 | 对照错误提示和接口参数定义，检查对应的参数 |
| 10000 | 参数不合法：本接口不支持该类型订单发起退款 | 请检查order_id是否正确，交易系统订单请传入交易系统订单号，担保支付订单请传入担保交易单号 |
| 10000 | 参数不合法：(ots72128388728472)商品单不存在 | 按以下步骤排查： 1. 检查item_order_id是否正确，注意item_order_id是商品单 2. 检查order_id与item_order_id是否匹配。用订单查询接口查询商户单下的所有商品单列表，检查item_order_id是否在列表中。 |
| 12001 | 操作过于频繁，请稍后再试 | 稍后再试 |
| 13000 | 系统错误，请重试 | 请重试，若多次重试仍然报错，请联系oncall |
| 20000 | 订单不存在 | 检查order_id是否正确，order_id与appid是否匹配，order_id与登录的用户是否匹配 |
| 22000 | 订单状态不支持退款 | 请检查订单状态：订单未支付不允许发起退款 |
| 22001 | 商品单(motb718283)状态xxx,不支持发起退款 | 商品单的状态是xxx，该状态下不允许发起退款 1. 退款中，需要等该笔退款完结后，才能再次发起 2. 履约中/已履约，请核对订单规则，确认此状态是否允许退款。 |
| 22002 | 无可退款的商品单 | 订单下所有的item处于不可退状态时，无法发起退款，参考22001的说明 |
| 22004 | 外部退款单号重复 | 开发者生成的外部退款单号以前已经用过了，请重新生成 |
| 22007 | 退款的商品总数量超限 | 单次退款的商品单数量不能超过100个，若超过了，请分批发起 |
| 22009 | 履约状态不同的商品单不能同时发起退款,请分别发起 | 商品单履约状态不一致，请分别发起(由于履约状态不一致的商品单资金状态可能不同，若同时发起可能导致卡单，所以建议分别发起) |
| 22012 | 退款来源不支持退款 | 退款来源有: 用户,开发者,抖音客服 |
| 22013 | 退款金额不能大于实付金额 | 请修改退款金额 |
| 22013 | 商品单(motb71263537)退款金额超过可退金额 | 请修改退款金额 |
| 22013 | CPS(motb72128284)商品单退款金额必须>=实付金额*n% | CPS订单退款时，item单的退款金额必须>=实付的n% |
错误码
| 错误码 | 错误提示 | 建议解决方案 |
|---|---|---|
| 10000 | 参数不合法：xxx参数不合法 | 对照错误提示和接口参数定义，检查对应的参数 |
| 10000 | 参数不合法：本接口不支持该类型订单发起退款 | 请检查order_id是否正确，交易系统订单请传入交易系统订单号，担保支付订单请传入担保交易单号 |
| 10000 | 参数不合法：(ots72128388728472)商品单不存在 | 按以下步骤排查： 1. 检查item_order_id是否正确，注意item_order_id是商品单 2. 检查order_id与item_order_id是否匹配。用订单查询接口查询商户单下的所有商品单列表，检查item_order_id是否在列表中。 |
| 12001 | 操作过于频繁，请稍后再试 | 稍后再试 |
| 13000 | 系统错误，请重试 | 请重试，若多次重试仍然报错，请联系oncall |
| 20000 | 订单不存在 | 检查order_id是否正确，order_id与appid是否匹配，order_id与登录的用户是否匹配 |
| 22000 | 订单状态不支持退款 | 请检查订单状态：订单未支付不允许发起退款 |
| 22001 | 商品单(motb718283)状态xxx,不支持发起退款 | 商品单的状态是xxx，该状态下不允许发起退款 1. 退款中，需要等该笔退款完结后，才能再次发起 2. 履约中/已履约，请核对订单规则，确认此状态是否允许退款。 |
| 22002 | 无可退款的商品单 | 订单下所有的item处于不可退状态时，无法发起退款，参考22001的说明 |
| 22004 | 外部退款单号重复 | 开发者生成的外部退款单号以前已经用过了，请重新生成 |
| 22007 | 退款的商品总数量超限 | 单次退款的商品单数量不能超过100个，若超过了，请分批发起 |
| 22009 | 履约状态不同的商品单不能同时发起退款,请分别发起 | 商品单履约 状态不一致，请分别发起(由于履约状态不一致的商品单资金状态可能不同，若同时发起可能导致卡单，所以建议分别发起) |
| 22012 | 退款来源不支持退款 | 退款来源有: 用户,开发者,抖音客服 |
| 22013 | 退款金额不能大于实付金额 | 请修改退款金额 |
| 22013 | 商品单(motb71263537)退款金额超过可退金额 | 请修改退款金额 |
| 22013 | CPS(motb72128284)商品单退款金额必须>=实付金额*n% | CPS订单退款时，item单的退款金额必须>=实付的n% |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.douyin.com/api/trade_basic/v1/developer/refund_create/' \
--header 'Content-Type: application/json' \
--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":"不想要了"}]
}'响应示例响应示例
200 - 示例 1
{
"err_no": 0,
"err_msg": "string",
"err_tips ": "string",
"log_id": "string",
"data": {
"refund_id": "string",
"refund_audit_deadline": 0
}
}请求参数
Body 参数application/json