视频号
取消
中文
中文
EN
取消
  • 介绍

    • # 撤销用户已核销团购优惠

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：withdrawconsume

    撤销用户已核销团购优惠

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/channels/ec/voucher/revoke?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：164

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    revoke_request_nostring是撤销操作幂等串，商户自定义，请保证在小店下唯一
    reovke_vouchersobjarray是待撤回核销的券列表，最多10张，需要属于同一个订单，不能为空。对于次卡类型商品，如果传多个相同的ReovkeVoucher，代表撤销多次。撤销核销多次/多张同时成功或同时失败，不会部分成功。
    consume_request_nostring否撤销核销次卡时必须要传此字段，说明撤销的核销单号

    # Body.reovke_vouchers(Array) Object Payload

    待撤回核销的券列表，最多10张，需要属于同一个订单，不能为空。对于次卡类型商品，如果传多个相同的ReovkeVoucher，代表撤销多次。撤销核销多次/多张同时成功或同时失败，不会部分成功。

    参数名类型必填说明
    encrypted_codestring否券加密code，和券code二选一
    codestring否券code，和券加密code二选一
    sku_idstring否商品下的skuid,填写code时必填
    cancel_countnumber否已废弃

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    voucher_listArray用户券详情
    fail_voucher_listobjarray无法操作的券，在明确有券无法核销时返回，含无法核销原因

    # Res.fail_voucher_list(Array) Object Payload

    无法操作的券，在明确有券无法核销时返回，含无法核销原因

    参数名类型说明
    codestring操作的券code，核销时传code时或者传了有效的加密code时返回
    sku_idstring操作的券sku_id，核销时传code时或者传了有效的加密code时返回
    encrypted_codestring核销时传的加密code非法返回
    ret_codestring操作结果
    ret_msgstring操作结果说明

    # 4. 注意事项

    • 用户核销成功后、资金结算前可撤销核销，撤销时如券仍在有效期内，券变为【待使用】用户可再次使用；如撤销时券已过有效期，券变为【已过期】，触发过期自动退款； -核销成功后，如资金已结算，不支持撤销核销； -核销成功后，到达资金结算时间点，平台将自动发起分账，按照技术服务费率、佣金率等计算并分账至对应账户；

    • 如撤销时接口返回“存在券无法执行此操作”失败，表明券为锁定状态（通常为核销处理中）。商家遇此情况可间隔1秒重试一次。如多次重试仍失败，则需要查询券信息、判断券状态是否符合撤销核销条件（券状态为已核销，如已核销仍不能撤销成功，则可能过了资金结算时间点）

    • 单商户限频200QPS

    # 5. 代码示例

    请求示例

    // 示例：加密code模式
{
   "revoke_request_no": "233244dfgfdfgsdfgsdf",
   "reovke_vouchers": [
       {
           "encrypted_code":"223dfsdf"
       },
       {
           "encrypted_code":"3445gffgh"
       }
    ]
}

// 示例：非加密code模式
{
   "revoke_request_no": "233244dfgfdfgsdfgsdf",
   "reovke_vouchers": [
       {
           "code":"123412",
           "sku_id":"fdsfdf"
       },
       {
           "code":"2235",
           "sku_id": "fdsfdf",
           "cancel_count":1
        }
    ]
}

    返回示例

    {
   "errcode": 0,
   "errmsg": "成功",
   "voucher_list":[
   {
     "code":"232323",
     "status": 1,
     "send_time": 1699856182,
     "update_time": 1699856182,
     "start_time": 1699856182,
     "end_time": 1699856182,
     "consume_time": 1699856182,
     "refund_time": 1699856182,
     "product_id":  "kbfff",
     "consume_store_name": "xxx旗舰店",
     "voucher_type": 1,
     "voucher_buy_amount": 0,
     "voucher_actual_amount": 0,
     "telphone_no": "fasdf343df34545",
     "openid": "xsdfs4534543534534",
     "code_type": 1,
     "order_id": "23434sdfsdf34342",
     "sku_id": "fdsfdf"
   },
   {
     "code":"23232323",
     "status": 1,
     "send_time": 1699856182,
     "update_time": 1699856182,
     "start_time": 1699856182,
     "end_time": 1699856182,
     "consume_time": 1699856182,
     "refund_time": 1699856182,
     "product_id":  "kbfff",
     "consume_store_name": "xxx旗舰店",
     "voucher_type": 1,
     "voucher_buy_amount": 0,
     "voucher_actual_amount": 0,
     "telphone_no": "fasdf343df34545",
     "openid": "xsdfs4534543534534",
     "code_type": 1,
     "order_id": "23434sdfsdf34342",
     "sku_id": "fdsfdf"
   },
   {
     "code":"32434454545",
     "status": 1,
     "send_time": 1699856182,
     "update_time": 1699856182,
     "start_time": 1699856182,
     "end_time": 1699856182,
     "consume_time": 1699856182,
     "refund_time": 1699856182,
     "product_id":  "kbfff",
     "consume_store_name": "xxx旗舰店",
     "voucher_type": 1,
     "voucher_buy_amount": 0,
     "voucher_actual_amount": 0,
     "telphone_no": "fasdf343df34545",
     "openid": "xsdfs4534543534534",
     "code_type": 1,
     "order_id": "23434sdfsdf34342",
     "sku_id": "fdsfdf"
   }
   ]
}

    # 6. 错误码

    此接口没有特殊错误码，可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    # 7. 适用范围

    本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。