发起退款

更新时间 2024-07-24 02:58:49

我的收藏

当开发者需要替用户发起退款时，可用该接口替用户发起退款。

使用限制

请不要滥用退款能力，如果发现滥用退款能力，平台会进行惩处。

接口说明

•

一笔订单可以多次退款。微信渠道不超过 50 次，支付宝渠道不超过 300 次。

•

交易时间超过 1 年的订单无法提交退款。

•

申请退款接口的返回仅代表业务的受理情况，退款是否成功，可以接收退款通知或者退款查询接口主动获取。

•

银行卡支付的退款 7 天内到账，支付宝支付（余额、银行卡快捷支付等）的退款 3 个工作日内到账，微信支付（余额、银行卡快捷支付等）的退款 7 天内到账。（退款优先原路退，如用户使用尾号为 1234 的招行借记卡付款，则退款至用户尾号为 1234 的招行借记卡）。

退款流程

退款流程如下：

过期自动退说明

•

过期自动退的退款被拒绝退款后，不会再次发起。

•

在交易系统产生的订单，如果用户购买的商品是过期退商品，在商品到达过期时间后，交易系统会自动发起退款，创建退款单，退款流程和用户发起退款流程相同。

•

发起过期自动退条件：

◦

非 POI 商品：

▪

前端传入合法的商品过期时间。

▪

前端传入的 goodsLabels 中包含过期退标签。

◦

POI 团购商品：

▪

POI 商品设置了过期时间。

▪

POI 商品的 sub_title 包含过期退标签。

◦

可以通过查询券状态接口的valid_end_time字段获取商品的过期时间

◦

担保支付不会自动发起过期自动退，仍需开发者处理。过期自动退的退款单由系统创建，因此退款申请回调和状态通知回调 cp_extra 会是空值。

外部退款单号说明：

•

外部退款单号务必确保在同一小程序内不会重复

未核销/已核销的 item 需要分开发起退款

•

开发者发起退款，一次退款不能同时包含核销前和核销后的item_order，请分别发起核销前或核销后退款。

部分金额退功能说明

在某些特殊的场景下（次卡、酒旅订单等），用户退 item_order 的退款金额不等于实付金额，开发者需要指定用户退款的 item_order 的退款金额（退款 item_order 部分金额）。交易系统也支持了该特殊场景，允许开发者在前端组件和开发者发起退款的 Open API 指定 item_order 退款金额。

开发者需要使用部分金额退功能，请联系对应的行业运营开通。

若未指定 item_order 退款金额，则和普通退款（退实付金额）相同。

如果该 item_order 已经退款成功，不能再发起退款。不支持已退款成功的 item_order，再发起退款。

次卡退款说明

次卡仅支持开发者用openAPI发起退款，开发者必须指定item_order和对应的退款金额

次卡仅支持退剩余未核销金额，已核销的金额不支持退款。如果次卡的所有次数均已核销，则不支持发起退款。

次卡仅允许退款一次，即如果次卡已退款成功则无法再次发起退款

次卡不支持过期自动退

基本信息

基本信息
HTTP URL	https://open.douyin.com/api/apps/trade/v2/refund/create_refund
HTTP Method	POST
Scope	industry_open.trade.refund
权限要求	不需要用户授权

请求头

参考通用参数-开发者请求公共参数

请求参数

对于历史上没有接入过“担保支付”和“交易模板 1.0”两个系统的开发者可以忽略“旧系统”这个概念

•

新系统订单退款，必传item_order_detail字段

•

旧系统订单退款，必传refund_total_amount，(旧系统是指通过担保交易和旧交易模板产生的订单)

•

item_order_detail 和 refund_total_amount 不能同时传入

•

通过开发者接口发起退款，请注意 item_order 的状态（待使用和已核销可以发起退款，其他状态无法发起退款）

•

用户发起退款，只有 item_order 的状态为待使用状态才可以发起退款

•

开发者发起退款和用户发起退款、过期自动退都需要退款审核，需要调用 退款审核结果同步 接口同步同意退款还是拒绝退款。

名称	类型	是否必填	描述	示例值
out_order_no	`string`	是	开发者侧订单号，长度 <= 64 byte	123123131
out_refund_no	`string`	是	开发者侧退款单号，长度 <= 64 byte	123123
cp_extra	`string`	否	开发者自定义透传字段，不支持二进制，长度 <= 2048 byte	extra_info
order_entry_schema	`object`	是	退款单的跳转的 schema	详见下方 order_entry_schema 参数详解
notify_url	`string`	否	退款结果通知地址。此地址在接入流程行业模版使用指南-消息通知中设置。长度 <=512byte	https://xxx
item_order_detail	`Array<object>`	否	需要发起退款的商品单信息，数组长度<100 注意：交易系统订单必传	详见下方 item_order_detail 参数详解
refund_total_amount	`int64`	否	退款总金额，单位分 •担保交易订单必传 •交易系统订单该字段不生效	100

order_entry_schema 信息

名称	类型	是否必填	描述	示例值
path	`string`	是	订单详情页路径，没有前导的/，该字段不能为空，长度 <= 512byte	pages/indexx
params	`string`	否	路径参数，自定义的 json 结构，序列化成字符串存入该字段，平台不限制，但是写入的内容需要能够保证生成访问订单详情的 schema 能正确跳转到小程序内部的订单详情页，长度 <= 512byte	{\"id\":\"cx\"}

item_order_detail 信息

名称	类型	是否必填	描述	示例
item_order_id	`string`	是	商品单号，参见通用参数-重要 ID 字段说明说明	ot7072366682238
refund_amount	`int64`	否	该 item_order 需要退款的金额，单位分，不能大于该 item_order 实付金额且要大于 0 需要指定 item_order 的退款金额，需要申请开通指定金额退款权限才能使用	100

请求示例

交易系统订单退款请求示例

text复制
curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/refund/create_refund' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxx' \
--data-raw='{
        "out_order_no": "123123131",
        "out_refund_no": "123123",
        "cp_extra": "extra_info",
        "order_entry_schema": {
            "path": "page/xxx",
            "params": "{\"id\":1}"
        },
        "notify_url": "https://xxx",
        "item_order_detail": [
                {
                        "item_order_id": "xxx",
                        "refund_amount": 100
                }
        ]
}'

担保交易、旧交易系统订单退款的请求示例

text复制
curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/refund/create_refund' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxx' \
--data-raw='{
        "out_order_no": "123123131",
        "out_refund_no": "123123",
        "cp_extra": "extra_info",
        "order_entry_schema": {
            "path": "page/xxx",
            "params": "{\"id\":1}"
        },
        "notify_url": "https://xxx",
        "refund_total_amount": 100
}'

响应参数

名称	类型	是否必填	描述	示例值
data	`object`	否	返回数据信息	success
extra	object	是	额外信息，参考通用参数中的说明

data 信息

名称	类型	是否必填	参数描述	示例值
refund_id	`string`	是	抖音开放平台交易系统内部退款单号	ot12312312
refund_audit_deadline	`int64`	是	退款审核的最后期限，13 位 unix 时间戳，精度：毫秒通常是3天(从退款发起时间开始算)	151231321231

响应示例

正常示例

json复制
{
  "data": {
    "refund_id": "ot12312312",
    "refund_audit_deadline": 151231321231
  }, 
  "extra": {
    "sub_error_code": 0,
    "sub_description": "success",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 0,
    "description": "success"
  }
}

正常示例

json复制
{
  "data": {
    "error_code": 13000,
    "description": "系统错误"
  },
  "extra": {
    "sub_error_code": 13000,
    "sub_description": "系统错误",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 2191000,
    "description": "" 
  }

错误码

详情参见错误码/返回码。

错误码	错误提示	建议解决方案
10000	参数不合法：(ots72128388728472)商品单不存在	按以下步骤排查： 1.检查item_order_id是否正确，注意是item_order_id，不是商户单id 2.检查out_order_no与item_order_id是否匹配。用查询券状态接口查询商户单下的所有item列表，检查item_order_id是否在列表中。
11001	访问未授权	退款金额小于实付金额的被判断为部分退款，需要申请权限，请联系行业运营
20000	订单不存在	检查out_order_no是否正确，out_order_id与appid是否匹配
22000	订单状态不支持退款	订单未支付或已关闭则不允许再发起退款
22001	(ots7218277338394847)商品单状态不支持退款	订单item子单的状态不允许发起退款，用查询券状态接口查询item单的状态： 1.item处于[退款中,退款完成]状态时，不允许退款 2.预约类的item，处于[退款中,退款完成,预约中]状态时不允许退款。 a.下单即预约(门票)的item，预约中不允许退款，可以取消预约后发起退款 b.先买后约(预售券)的item，预约中/预约成功状态不允许退款，可以取消预约或者等预约完成时间过后，item变为已核销状态后，再发起退款 3.次卡类型，若所有次数均已核销则不允许退款
22002	无可退款的商品单	订单下所有的item处于不可退状态时，无法发起退款，参考22001的说明
22004	外部退款单号重复了	开发者生成的外部退款单号以前已经用过了，请重新生成
22006	退款单状态不允许设置商家审核结果	退款审核状态前置步骤未完成，等几分钟后再重新发起
22007	超出单次最大可退款的商品数量	一般是单次退款item订单的数量超过了100
22008	退款商品数量超过可退款的商品数量	用户可以发起退款的item单数小于请求数
22009	不支持同时发起核销前和核销后退款	发起退款的item单列表中包含已核销和未核销的，需要分别发起退款
22010	只允许整单退款，请发起整单退款	门票、下单即预约场景，订单只允许整单退
22011	加价单不允许发起退款	预约失败时加价单会自动发起退款，不允许开发者发起退款。
22012	退款来源不支持退款	退款来源有: 用户,开发者
22013	退款金额不符合条件，提交退款失败	几种可能的场景： 1.次卡类型，发起退款金额 > 剩余未核销金额；需要修改退款金额重新发起 2.外卖类型，发起退款金额 > 剩余可退金额；需要修改退款金额重新发起 3.小程序开通了item多次退白名单，发起退款金额>item剩余可退金额；需要修改退款金额重新发起
22014	订单有其他退款申请正在进行中，不支持发起退款申请
22015	订单状态不支持取消订单