• OpenAPI 简介
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 支付
  • 评价
  • 交易工具
  • 交易系统
  • 担保支付(即将下线)
  • 进件
  • 支付
  • 退款
  • 发起退款
  • 退款结果查询
  • 退款结果回调
  • 退款常见问题
  • 结算及分账
  • 退分账
  • 提现
  • 获取对账单
  • 接口获取页面链接
  • 订单推送
  • 抖店绑定
  • 运营
  • 生活服务
  • 垂直行业
  • 其它
  • 将退款成功或失败的消息通知给开发者/服务商。

    使用限制

    接口说明

      1.回调地址会优先使用开发者在发起退款接口传入的notify_url,如果发起退款时没有传入,会请求开发者在进件时设置的URL,该URL查看步骤如下【开放平台控制台->小程序->能力->支付能力->支付设置】。
      2.退款成功或者退款失败都会回调。
      3.平台会通过一定的策略定期重新发起回调,尽可能提高回调的成功率,但不保证通知最终能成功。退款回调接口最多重试 16 次,重试间隔分别为(15s/15s/30s/3min/10min/20min/30min/30min/30min/60min/3h/3h/3h/6h/6h)。
      4.若长时间未收到回调,开发者可以通过主动请求退款结果查询接口,感知退款结果。
      5.开发者服务端接收到异步通知时,必须通过验签(验证通知中的 msg_signature 参数)来确保支付通知是由抖音发送的。
      6.在开发者服务端收到回调且处理成功后,需要按以下 json 返回表示处理成功,否则小程序服务端会认为通知失败进行重试。
    { "err_no": 0, "err_tips": "success" }

    回调参数

    名称
    类型
    是否必填
    最大长度
    描述
    示例值
    timestamp
    string
    12
    Unix 时间戳,字符串类型
    1644399124
    nonce
    string
    4
    随机数
    797
    msg
    string
    -
    订单信息的 json 字符串
    {\"appid\":\"app_id_test\",\"cp_refundno\":\"out_refund_no\",\"cp_extra\":\"\",\"status\":\"SUCCESS\",\"refund_amount\":999,\"is_all_settled\":false,\"refunded_at\":1691372517,\"message\":\"\",\"order_id\":\"order_id_123\",\"refund_no\":\"refund_no_123\"}
    type
    string
    32
    回调类型标记,退款成功回调为"refund"
    refund
    msg_signature
    string
    128
    签名,详见签名DEMO
    52fff5f7a4bf4a921c2daf83c75cf0e716432c73
    msg 参数
    回调参数中的 msg 字段,为以下内容序列化得到的 json 字符串
    名称
    类型
    是否必填
    最大长度
    描述
    示例值
    appid
    string
    64
    当前交易发起的小程序id
    tt07e3715e98c9aac0
    cp_refundno
    string
    64
    开发者侧的退款订单号
    401020220222383677956847349760
    cp_extra
    string
    2048
    预下单时开发者传入字段
    一些附加信息
    status
    string
    -
    状态枚举值:
    SUCCESS:成功
    FAIL:失败
    SUCCESS
    refund_amount
    number
    [1,99999999999]
    退款金额,单位为分
    100,即1元
    refunded_at
    number
    10
    退款时间,Unix 时间戳,10 位,整型数,秒级
    1644399124
    message
    string
    356
    退款失败原因描述,详见发起退款错误码
    商户余额不足
    order_id
    string
    64
    抖音侧订单号
    7064214528778700000
    refund_no
    string
    64
    抖音侧退款单号
    N6926510404499680000
    is_all_settled
    bool
    -
    是否为分账后退款
    false

    回调示例

    { "timestamp": "1602507471", "nonce": "797", "msg": { "appid": "ttb8bece032785e300", "cp_refundno": "RD818440313350422528011772773", "cp_extra": "", "status": "SUCCESS", "refund_amount": 13800, "is_all_settled": false, "refunded_at": 1645523993, "message": "成功", "order_id": "7064214528778700000", "refund_no": "N6926510404499680000" }, "msg_signature": "52fff5f7a4bf4a921c2daf83c75cf0e716432c73", "type": "refund" }

    响应参数

    名称
    类型
    是否必填
    最大长度
    描述
    示例值
    err_no
    number
    -
    详见错误码
    0
    err_tips
    string
    -
    详见错误描述
    success

    响应示例

    正常响应示例

    { "err_no": 0, "err_tips": "success" }

    异常响应示例

    { "err_no": 400, "err_tips": "business fail" }