抖音
  1. 退货退款
抖音
  • 简介
  • 签名算法
  • 接口调用凭证
    • 经营能力调用凭证
      • BusinessToken 生成
      • BusinessToken 刷新
      • 经营能力当前状态查询
    • 非用户授权调用凭证
      • 获取应用授权调用凭证
      • getAccessToken
    • 用户授权调用凭证
      • 获取用户授权调用凭证
      • 刷新用户授权调用凭证
      • 刷新授权调用凭证
  • 登录
    • code2Session
      POST
  • 小程序码与小程序链接
    • Schema 链接
      • 生成SchemaV2
      • 查询SchemaV2
      • 查询Schema配额V2
    • Link链接
      • 生成 Link V2
      • 查询 Link 配额V2
      • 查询 Link V2
    • 二维码
      • 生成QRCodeV2
  • 私域经营
    • 私信管理
      • IM主动授权webhook
      • 主动发送私信
    • 群聊管理
      • 粉丝群webhook
        • 用户加群申请 webhook
        • 用户加群webhook
      • 查询群信息
      • 设置进群问候语&群公告
      • 创建粉丝群
      • 取消进群问候语&群公告配置
      • 变更用户入群申请状态
      • 查询用户剩余建群额度
      • 查询群主所在群的用户入群申请状态
    • 经营工具
      • 小程序引导卡片
        • 创建/更新小程序引导卡片模板
        • 查询小程序引导卡片模板
        • 删除小程序引导卡片模板
      • 图片上传
  • 线索组建
    • 创建线索组件
    • 查询已创建的线索组件
    • 更新线索组件
    • 删除线索组件
  • 视频能力
    • 视频数据查询
      • 查询特定视频的视频数据
    • 近 30 天用户视频数据
      • 获取视频基础数据
      • 获取视频点赞数据
      • 获取视频评论数据
      • 获取视频播放数据
      • 获取视频分享数据
    • 视频评论数据
      • 置顶评论
      • 评论回复列表
      • 评论列表
      • 回复视频评论
    • videoid转换itemid
    • itemid转换encryptid
  • 搜索能力
    • 创建抖音搜索直达子服务
    • 查询已创建的抖音搜索直达子服务列表
    • 删除抖音搜索直达子服务
    • 校验是否有搜索直达服务的创建权限
  • 电商
    • 注册小程序积分阈值
    • 注册小程序预览图
    • 查询订单的定制完成状态
    • 定制类小程序开发者注册信息
    • 退会
  • 生活服务
    • 店铺接入
      • 商铺同步
      • 查询店铺
      • 获取抖音POI ID
      • 店铺匹配任务结果查询
      • 店铺匹配状态查询
      • 提交门店匹配任务
      • 查询全部店铺信息接口(天级别请求5次)
      • 查询店铺全部信息任务返回内容
    • 商品库接入
      • (老版本)SKU同步
      • (老版本)sku拉取(该接口由接入方实现)
      • (老版本)多门店SPU同步
      • (老版本)多门店SPU状态同步
      • (老版本)多门店SPU库存同步
      • (老版本)多门店SPU信息查询
      • 创建/修改团购商品
      • 免审修改商品
      • 上下架商品
      • 同步库存
      • 查询商品模板
      • 查询商品草稿数据
      • 查询商品线上数据
      • 查询商品线上数据列表
      • 查询商品草稿数据列表
      • 用于创建多 SKU 商品。
      • 查询商品品类
    • 端内消息同步
      • 订单同步
    • poi数据接入
      • 获取POI基础数据
      • POI用户数据
      • POI服务基础数据
      • POI服务成交用户数据
      • POI热度榜
      • POI认领列表
    • poi基础能力
      • 通过高德POI ID获取抖音POI ID
    • 优惠卷接入
      • 优惠券同步
      • 优惠券更新
    • CPS佣金设置与查询
      • 通用佣金计划查询带货数据
      • 通用佣金计划查询达人带货数据
      • 通用佣金计划查询带货达人列表
      • 通用佣金计划查询达人带货详情
      • 查询通用佣金计划
      • 发布/修改通用佣金计划
      • 修改通用佣金计划状态
      • 发布/修改直播间定向佣金计划
      • 发布/修改短视频定向佣金计划
      • 修改定向佣金计划状态
      • 取消定向佣金计划指定的达人
      • 查询达人的定向佣金计划带货数据
      • 通过商品 ID 查询定向佣金计划
      • 查询定向佣金计划带货汇总数据
  • 用户信息
    • 用户抖音主页数据
      • 获取用户视频情况
      • 获取用户粉丝数
      • 获取用户点赞数
      • 获取用户评论数
      • 获取用户分享数
      • 获取用户主页访问数
  • 分享
    • 拍抖音任务
      • 拍抖音任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 拍抖音互动任务
      • 拍抖音互动任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 分享任务
      • 创建任务
      • 查询用户任务进度
  • 客服
    • CustomerServiceUrl
  • 小程序卷
    • 「小程序券」直播玩法接入指南
    • 小程序券API列表
    • 更新日志
    • 用户卷管理
      • 查询用户可用券信息
      • 用户领券结果回调通知
      • 用户撤销核销券
      • 用户手机号授权结果回调通知
      • 用户核销券
    • 主播授权管理
      • 查询主播发券配置信息
      • 修改主播发券权限状态
      • 更新主播发券库存上限
      • 主播发券权限配置
    • 卷模版管理
      • 查询授权用户发放的活动信息
      • 创建券模板
      • 修改券模板
      • 删除券模板
      • 修改券模板库存
      • 修改券模板状态
      • 查询券模板发放统计数据
      • 查询券模板
      • 查询对账单
    • 接口发放管理
      • 创建开发者接口发券活动
      • 开发者接口发券
      • 删除开发者接口发券活动
  • 交易系统
    • 通用交易系统
      • 通用参数
      • 进件
        • 接口进件
          • 图片上传
          • 发起进件
          • 进件查询
        • 获取进件页面链接
          • 开发者获取小程序收款商户/合作方进件页面
          • 服务商获取小程序收款商户进件页面
          • 服务商获取服务商进件页面
          • 服务商获取合作方进件页面
      • 标签
        • 查询标签组信息
      • 订单
        • 查询CPS信息
        • 查询订单信息
        • 支付结果回调
      • 退款
        • 发起退款
        • 查询退款
        • 同步退款审核结果
        • 退款申请回调扩展点
        • 退款结果通知
      • 履约
        • 推送履约状态
      • 结算
        • 发起分账
        • 查询分账
        • 通知分账结果
      • 提现
        • 接口提现
          • 商户余额查询
          • 商户提现
          • 商户提现结果查询
        • 获取提现页面链接
          • 开发者获取小程序收款商户/合作方提现页面
          • 服务商获取小程序收款商户提现页面
          • 服务商获取服务商提现页面
          • 服务商获取合作方提现页面
      • 获取对账单
        • 获取资金账单
        • 获取交易账单
    • 生活服务交易系统(金融合板)
      • 通用参数
      • 错误码和返回码
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询 CPS 信息
      • 预下单
        • 预下单扩展点
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销算价扩展点
      • 支付
        • 支付结果通知
      • 核销
        • 抖音码
          • 验券准备
          • 验券
          • 撤销核销
          • 券码核销通知
          • 撤销核销通知
        • 三方码
          • 推送核销状态
          • 撤销核销
      • 分账
        • 查询分账
      • 退货退款
        • 开发者发起退款
        • 同步退款审核结果
        • 查询退款
        • 退款扩展点
        • 退款结果通知
    • 生活服务交易系统(账号融合版)
      • 错误码和返回码
      • 通用参数
      • 预约
        • 创建预约单
        • 预约接单结果回调
        • 商家取消预约
        • 用户取消预约
        • 查询预约单信息
        • 预约接单超时回调
        • 预约取消/完成通知
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询CPS信息
      • 预下单
        • 预下单回调
        • 关闭订单
        • 发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 算价扩展点
        • 营销查询算价二合一
      • 支付
        • 通知支付结果
      • 核销
        • 抖音码
          • 验券准备
          • 验券
        • 三方码
          • 推送核销状态
        • 核销工具
          • 查询用户券列表
          • 查询订单可用门店
          • 券核销消息通知
          • 撤销核销消息通知
          • 设置商家展示信息
          • 查询商家配置文案
          • 设置订单详情页按钮白名单接口
          • 设置小程序跳转path
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
      • 退货退款
        • 发起退款
          POST
        • 同步退款审核结果
          POST
        • 查询退款
          POST
        • 退款申请回调
          POST
        • 通知退款结果
          POST
    • 行业交易系统
      • API 调用
        • 通用参数
        • 错误码和返回码
      • 回调设置
        • 设置回调地址
        • 查询回调地址
      • 预下单
        • 查询 CPS 信息
        • 查询订单信息
        • 预下单回调
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 设置扩展点
        • 算价扩展点
    • 支付
      • 通知支付结果
    • 核销
      • 抖音码
        • 验券准备
        • 验券
        • 查询劵状态信息
      • 三方码
        • 推送核销状态
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
    • 提货退款
      • 开发者发起退款
      • 同步退款审核结果
      • 查询退款
      • 退款申请回调
      • 通知退款结果
  • 内容安全
    • 内容安全检测
    • 图片检测V2
    • 图片检测V3
  • 泛知识
    • 角色系统
      • 错误码
      • 上传材料
      • 代运营服务商帮老师或代运营模式机构入驻
      • 自营机构/服务商入驻
      • 新增角色
      • 查询基础认证资质
      • 更新基础认证资质
      • 查询类目认证资质
      • 更新类目认证资质
      • 添加类目认证资质
      • 获取审核任务详情
      • 小程序绑定角色
      • 小程序解除绑定角色
      • 查询小程序已绑定的角色
      • 角色授权小程序
      • 解除授权小程序
      • 查询授权小程序
      • 更新授权小程序授权信息
      • 查询抖音号绑定、能力授权
      • 新增抖音号绑定、能力授权
      • 解除抖音号绑定、解除能力授权
      • 查询实体ID
      • 查询实体已绑定抖音号列表
    • 课程库
      • 【泛知识】回调通知
      • 【泛知识】课程库 FAQ
      • 【泛知识】错误码
      • 【泛知识】上传课程资源
      • 【泛知识】查询课程资源上传状态
      • 【泛知识】查询资质
      • 【泛知识】添加课程
      • 【泛知识】修改课程
      • 【泛知识】修改课程状态
      • 【泛知识】查询课程
      • 【泛知识】修改课程免审
      • 【泛知识】查询免审课程
      • 【泛知识】修改商品退款规则
      • 【泛知识】查询可选退款规则
      • 【泛知识】查询课程类目信息
  • 担任支付
    • 进件
      • 进件状态回调
      • 发起进件请求
      • 图片上传接口
      • 进件状态查询
    • 支付
      • 支付结果回调
      • 支付常见问题
      • 预下单接口
      • 唤起收银台
      • 支付结果查询
    • 退款
      • 退款结果回调
      • 退款常见问题
      • 发起退款
      • 退款结果查询
    • 结算及分账
      • 收费规则
      • 结算及分账常见问题
      • 自动结算
        • 自动结算接入说明
        • 自动结算结果回调
        • 自动结算结果查询
      • 发起结算及分账
      • 结算及分账结果查询
      • 结算及分账结果回调
      • 可分账余额查询
    • 退分账
      • 发起退分账
      • 查询分账回退结果
    • 提现
      • 商户余额查询
      • 商户提现
      • 商户提现结果查询
      • 商户提现回调
    • 获取对账单
      • 获取交易账单
      • 获取资金账单
    • 接口获取页面链接
      • 进件
        • 开发者获取小程序收款商户/合作方进件页面
        • 服务商获取小程序收款商户进件页面
        • 服务商获取服务商进件页面
        • 服务商获取合作方进件页面
      • 提取
        • 开发者获取小程序收款商户/合作方提现页面
        • 服务商获取小程序收款商户提现页面
        • 服务商获取服务商提现页面
        • 服务商获取合作方提现页面
    • 订单推送
      • 订单同步
  • 评价
    • 获取评价数据
  • 其他
    • 用户登录态签名
    • 抖音开放平台与小程序视频打通能力
      • 抖音开放平台与小程序视频打通能力
      • 视频使用能力能力
    • 开放能力配置接口
      • 开放能力配置接口
      • 配置开放能力实现接口
      • 查询生效中配置接口
    • 解决方案测试实体管理接口
      • 解决方案测试实体管理接口
      • 新增测试实体接口
      • 查询测试实体接口
      • 删除测试实体接口
    • 直播间自定义封面
    • 上传资源
    • 能力申请
    • 查询能力申请状态
  • 订阅消息
    • 查询订阅消息模版库
    • 发送订阅消息
    • 查询小程序的模版列表
    • 添加模板
    • 删除已添加的模版
    • 查询新建订阅消息模板列表
    • 新建订阅消息模板
  • 小程序推广计划
    • 短视频任务
      • 创建任务
        • 小程序任务台能力
        • 创建任务
      • 查询任务台任务投稿视频数据(明细)
      • 查询任务台任务投稿视频数据
      • 查询小程序任务台任务 ID
      • 更新任务状态
      • 重新提交任务基础信息
      • 查询任务详情
      • 更新专属任务达人
      • 查询视频任务相关实时汇总数据
    • 直播间任务
      • 创建直播间任务
      • 更新直播间任务
  • 挂载
    • 自主挂载
      • 获取作者视频列表
      • 自主挂载存量视频绑定锚点
      • 自主挂载存量视频解绑锚点
    • 小程序直播挂载黑白名单管理能力
    • 拍抖音黑白名单管理能力
    • 申请短视频自主挂载能力
    • 查询短视频自主挂载能力申请状态
    • 申请直播自主挂载能力
    • 查询直播自主挂载能力申请状态
    • 申请短视频达人推广挂载能力
    • 查询短视频达人推广挂载能力申请状态
    • 查询直播达人推广挂载能力申请状态
    • 申请直播达人推广挂载能力
    • 短视频/直播自主挂载能力绑定抖音号
    • 获取短视频/直播自主挂载抖音号绑定二维码
    • 查询短视频/直播自主挂载能力绑定抖音号列表
    • 解除短视频/直播自主挂载能力抖音号绑定
    • 挂载权限校验
    • 修改短视频锚点配置
    • 查询短视频锚点配置
    • 查询短视频锚点配置修改记录及状态
    • 图片上传
    • 图片审核状态查询
    • 图片删除
    • 设置全局默认配置
    • 设置指定页面配置
    • 查询全局默认配置
    • 查询指定页面配置
    • 删除指定页面配置
    • 讲解卡动态更新
  • 分发
    • 添加小程序别名
    • 查询小程序别名
    • 修改小程序别名
    • 删除小程序别名
    • 设置小程序搜索标签
    • 查询小程序搜索标签列表
  • 引导关注抖音号
    • 绑定抖音号
    • 获取抖音号绑定二维码
    • 获取绑定抖音号列表
    • 解除抖音号绑定
  • 数据分析
    • 用户分析
      • 行为分析
      • 实时分析
      • 留存分析
      • 来源分析
      • 用户画像
      • 终端分析
      • 页面分析
    • 交易分析
      • 总览分析
      • 流量转化
      • 短视频交易分析
      • 获取直播房间数据
      • 直播数据分析
      • 直播交易分析
      • 商品分析
    • 短视频分析
      • 短视频投稿数据
      • 短视频总览数据
      • 短视频详细数据
      • 流量来源
    • 直播分析
      • 直播间详细数据
        • 接口 1
        • 接口 2
      • 直播间总览数据
      • 主播分析
    • 小房子直播分析
      • 小房子直播间总览数据
      • 小房子直播间详细数据
      • 小房子直播间订单数据
    • 留资分析
      • 组件使用数据
      • 流量来源
      • 组件详细数据
      • 组件使用对比
  • 服务类目
    • 获取已设置的服务类目
  • 直播间能力
    • 查询跳转抖音直播间能力申请状态
    • 申请跳转抖音直播间能力
    • 查询直播间状态组件能力申请状态
    • 申请直播间状态组件能力
  • 抖音开放能力
    • 查询抖音开放能力列表
    • 申请开通抖音开放能力
    • 查询scope配额详情
    • scope申请提额
    • 查询视频关键词列表
    • 新增视频关键词
    • 删除视频关键词
  • 页面结构自定义
    • 查询页面结构自定义能力申请状态
    • 申请页面结构自定义能力
  • 普通二维码绑定
    • 查询普通二维码绑定列表
    • 新增绑定二维码
    • 更新绑定二维码链接
    • 更新绑定二维码状态
    • 删除绑定二维码链接
  • 抖音号绑定
    • 获取抖音号绑定所需的资质模版列表
    • 获取抖音号绑定所需的资质模版信息
    • 输入抖音号绑定
    • 获取抖音号绑定二维码
    • 查询抖音号绑定列表及状态
    • 解除抖音号绑定
  • 流量主
    • 查询流量主开通状态
    • 开通流量主
    • 查询广告位列表
    • 新增广告位
    • 更新广告位状态
    • 查询广告收入
    • 查询广告结算单列表
  • 抖店绑定
    • 绑定抖店开放平台账号
    • 查询绑定的抖店开放平台账号信息
    • 配置抖店开放平台应用
    • 查询配置的抖店开放平台应用信息
    • 获取绑定抖店账号信息
  1. 退货退款

发起退款

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/api/apps/trade/v2/refund/create_refund

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

使用限制

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

接口说明

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

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

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

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

退款流程

退款流程如下:

img

过期自动退说明

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

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

  • 发起过期自动退条件:

  • 非 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 退款金额。

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

功能限制:非门票类CPS订单,不能指定 item_order 退款部分金额;门票类CPS订单支持核销前退款部分金额,不支持核销后退款部分金额。门票类CPS订单的每个item_order退款金额需 >= 实付金额*70%。​

不指定 item_order 退款金额 和 普通的退款(退实付金额)相同。​

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

次卡退款说明

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

次卡仅支持退剩余未核销金额,已核销的金额不支持退款​

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

次卡不支持过期自动退

请求头

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

请求参数

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

  • 新系统订单退款,必传item_order_detail字段
  • 旧系统订单退款,必传refund_total_amount,(旧系统是指通过担保交易和旧交易模板产生的订单)
  • item_order_detail 和 refund_total_amount 不能同时传入
  • 通过开发者接口发起退款,请注意 item_order 的状态(待使用和已核销可以发起退款,其他状态无法发起退款)
  • 用户发起退款,只有 item_order 的状态为待使用状态才可以发起退款
  • 开发者发起退款和用户发起退款、过期自动退都需要退款审核,需要调用 退款审核结果同步 接口同步同意退款还是拒绝退款。

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

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

}'

错误码

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

Q&A

1.如何判断订单是否在退款中/已退款

**A:查询退款**接口用 order_id 查询退款信息,可以得知订单是否发生了退款以及退款状态

2.为什么一直处于退款中

A:查询退款接口用 refund_id 查询退款信息,首先看 refund_status 是不是退款中,如果是,则按以下步骤确认:

      1. out_refund_no为空,说明退款申请回调未成功,请开发者确认自身系统接入了退款申请回调且正确响应了退款申请回调。交易系统会持续重试,直到回调成功。排查方法请参考:退款申请回调文档末尾的退款申请回调接口排查模块
      2. out_refund_no不为空,则看审核状态audit_status,如果是待审核状态,请同步审核结果。
      3. 以上都不是,请联系oncall

3.如何判断退款单的审核状态

A:查询退款接口查询退款信息,merchant_audit_detail.audit_status 是审核状态,merchant_audit_detail.refund_audit_deadline 是审核的最后期限

4.商家未同步退款审核结果,为什么退款成功了

**A:**退款审核有最后期限,一般是 3 天(从发起退款的时刻开始),在退款申请回调/查询退款能获取到,商家需要在有效期内同步审核结果。有效期过后,系统将默认审核通过。

5.哪些退款单需要审核,哪些不需要审核

A:

[抖音客服发起退款]、[预约失败交易系统自动发起加价单退款]无需审核

用户发起、开发者发起、过期自动退、下单即预约且预约失败自动发起退款都需要审核

6.退款审核/退款查询接口报错,订单不存在是什么原因

A:按以下步骤进行排查

  1. 如果是刚刚发起退款,查询接口有时延,建议延迟几秒重试一下

  2. 如果已经发起退款很久了,建议调查询退款接口,

    1. 如果查询不到则说明单号不存在,请检查请求参数。
    2. 大多数情况下,开发者用 out_refund_no 来审核退款或查询退款时报错,都是因为 out_refund_no 不存在导致,建议检查一下是否已经成功发起退款或者是否正确响应了退款申请回调。具体请参考退款申请回调文档末尾的退款申请回调接口排查模块

7.为什么开发者未发起退款,但是收到了退款申请回调/查询到订单处于退款中

A:除开发者发起外,还存在用户在退款组件发起、系统自动退款、抖音客服发起等场景,请通过查询退款接口查询订单的退款记录,并检查 refund_source 字段,可以获得具体的退款来源。

8.为什么订单会存在抖音客服发起的退款

A:用户找到抖音客服投诉,客服会联系商家确认后发起客服退款,如有疑问请咨询行业运营。客服退不需要商家审核,但需要开发者响应退款申请回调,客服退流程详见退款申请回调-接口说明模块的流程图。

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/trade/v2/refund/create_refund' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--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
                }
        ]
}'
响应示例响应示例
200 - 成功示例
{
  "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"
  }
}

请求参数

Header 参数
Content-Type
string 
必需
示例值:
application/json
access-token
string 
必需
示例值:
clt.xxx
Body 参数application/json
out_order_no
string 
必需

开发者侧订单号,长度 <= 64 byte

out_refund_no
string 
必需

开发者侧退款单号,长度 <= 64 byte

cp_extra
string 
可选

开发者自定义透传字段,不支持二进制,长度 <= 2048 byte

order_entry_schema
object 
必需
退款单的跳转的 schema
path
string 
必需

订单详情页路径,没有前导的/,该字段不能为空,长度 <= 512byte

params
string 
可选

路径参数,自定义的 json 结构,序列化成字符串存入该字段,平台不限制,但是写入的内容需要能够保证生成访问订单详情的 schema 能正确跳转到小程序内部的订单详情页,长度 <= 512byte

notify_url
string 
可选

退款结果通知地址。此地址在接入流程行业模版使用指南-消息通知中设置。长度 <=512byte

item_order_detail
array [object {2}] 
可选

需要发起退款的商品单信息,数组长度<100 注意:交易系统订单必传

item_order_id
string 
必需
商品单号,参见通用参数-重要 ID 字段说明说明
refund_amount
integer 
可选
该 item_order 需要退款的金额,单位分,不能大于该 item_order 实付金额且要大于 0 需要指定 item_order 的退款金额,需要申请开通指定金额退款权限才能使用
示例

返回响应

🟢200成功
application/json
Body
data
object 
必需
refund_id
string 
必需
抖音开放平台交易系统内部退款单号
refund_audit_deadline
integer 
必需
退款审核的最后期限,13 位 unix 时间戳,精度:毫秒 通常是3天(从退款发起时间开始算)
extra
object (opi数据接入extra) 
必需
description
string 
错误码描述
必需
error_code
integer 
错误码
必需
logid
string 
标识请求的唯一id
必需
now
integer 
毫秒级时间戳
必需
sub_description
string 
子错误码描述
必需
sub_error_code
integer 
子错误码
必需
🟠400请求有误
上一页
通知分账结果
下一页
同步退款审核结果
Built with