• OpenAPI 简介
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 支付
  • 运营
  • 生活服务
  • 通用能力
  • 生活服务交易系统(全融合版)
  • 生活服务交易系统(账号融合版)
  • 错误码和返回码
  • 通用参数
  • 预约
  • 查询接口
  • 预下单
  • 营销算价
  • 支付
  • 核销
  • 抖音码
  • 三方码
  • 核销工具
  • 查询用户券列表
  • 查询订单可用门店
  • 券核销消息通知
  • 撤销核销消息通知
  • 设置商家展示信息
  • 查询商家配置文案
  • 设置订单详情页按钮白名单接口
  • 设置小程序跳转path
  • 原生券信息查询
  • 【核销】核销原生券(简化版独有)
  • 【核销】加解锁(简化版独有)
  • 推结算状态
  • 分账
  • 退货退款
  • poi基础能力
  • CPS佣金设置与查询
  • 核销工具解决方案
  • 历史版本(不推荐使用)
  • 垂直行业
  • 其它
  • 使用限制

    接口说明

      超过核销时间1h后将无法撤销核销,此时消息通知将返回撤销失败状态及说明。
      由于网络波动等原因,可能会产生重复的通知消息,接入方需要做好幂等,正确处理。
      回调可能存在延时,开发者可以通过主动请求查询券信息,确认券撤销核销结果。
      在开发者服务端收到回调且处理成功后,需要按以下正常返回示例返回并且 HTTP 响应状态码设为 200,否则会认为通知失败进行重试。

    基本信息

    基本信息
    HTTP URL
    在抖音开放平台-核销工具小程序页面-开发-行业模板-券核销消息通知中订阅。
    HTTP Method
    POST

    请求头

    参见通用参数

    请求参数

    参数名称
    类型
    是否必填
    描述
    示例值
    msg
    string
    订单相关信息的 json 字符串
    见请求示例
    type
    string
    固定值:coupon_verify_cancel
    coupon_verify_cancel
    version
    string
    固定值:"2.0"。
    回调版本,用于开发者识别回调参数的变更
    2.0

    msg 字段

    字段名
    类型
    是否必填
    描述
    示例值
    app_id
    string
    小程序 app_id
    ttxxxxx
    status
    string
    撤销核销状态枚举值:
      SUCCESS:撤销核销成功
      FAIL:撤销核销失败
    SUCCESS
    verify_id
    string
    核销的唯一标识,在券核销消息通知中会给到。
    71843339522862999
    certificate_id
    string
    抖音原生团购券ID,即下单时传入的抵扣券ID
    71843339522862940
    cannot_cancel_msg
    string
    撤销核销失败原因
    超过核销时间1h后将无法撤销核销
    order_info
    object
    小程序交易系统订单信息

    order_info 字段

    字段名
    类型
    是否必填
    描述
    示例值
    order_id
    string
    核销工具在小程序交易系统产生的订单号
    ots7057435515980663049
    order_source
    string
    订单来源标识
      核销工具订单:fulfillment_tool
    fulfillment_tool

    请求示例

    curl --location --request POST 'https://xxxxxxx.net/api/v2/result_callback' \ --header 'Content-Type: application/json' \ --data-raw='{ "version": "2.0", //本次固定为2.0, 通过版本信息识别,用不同的结构体去解析上述关键参数 "msg": "{\"app_id\":\"ttxxxxx\",\"status\":\"SUCCESS\",\"verify_id\":\"71843339522862999\",\"certificate_id\":\"71843339522862940\",\"cannot_cancel_msg\":\"\",\"order_info\":{\"order_id\":\"ots7057435515980663049\",\"order_source\":\"fulfillment_tool\"}}", "type": "coupon_verify_cancel" }'

    msg 字段内容示例

    { "app_id": "ttxxxxx", "status": "SUCCESS", "verify_id": "71843339522862999", "certificate_id": "71843339522862940", "cannot_cancel_msg": "", "order_info": { "order_id": "ots7057435515980663049", "order_source": "fulfillment_tool" } }

    响应参数

    参数名称
    类型
    描述
    示例值
    err_no
    int64
    错误码
    0
    err_tips
    string
    错误提示
    success

    响应示例

    正常示例

    //正常返回响应且http状态码为200 //注意: //正常返回时一定要保证err_no和err_tips为下面标准返回方式,不然都认为失败,将会重试 { "err_no": 0, "err_tips": "success" }

    异常示例

    //异常响应或http状态码为非200, //字节服务端会不断重试 { "err_no": 1, //非0 "err_tips": "system error" //非success }