视频号本地生活
接口列表
核销用户的团购优惠

核销用户的团购优惠

⚠️

如果想获取encrypted_codes 来调用核销接口 用户从订单详情页跳转到商家创建团购优惠时配置的小程序verify_page,系统会自动在verify_page的path后面追加encrypted_codes的参数

例如商家配置的path为
1、/path/html?abc=xxxx 则系统会改为 /path/html?abc=xxxx&encrypted_codes=xxx
2、/path/html 则系统会改为 /path/html?encrypted_codes=xxx

注意:追加encrypted_codes参数时,只会追加用户正在查看的一张券encrypted_codes,商家如需在小程序内向用户展示所有券,可通过查询用户的团购列表反查后予以展示。

接口使用说明:
1、单商户限频200QPS。
2、请在收到系统失败时,不要换单重试,避免系统原单超时成功后,换单无法成功,导致商家侧与平台侧券状态不同。建议核销失败后,以幂等方式重试 或 先反查券(调用接口14、查询用户的团购优惠详情)确认当前券状态和最新的核销单号,明确核销是否成功后再决策。
3、每张券最多可反复操作核销-撤销核销10次

核销资金说明:
1、券核销成功后,到达资金结算时间点未发生撤销核销,平台将发起分账结算,从订单资金扣除平台技术服务费、达人带货佣金(如有)、团长带货服务费(如有)后,解冻剩余订单资金。分账结算批处理有额外耗时,通常在24小时内全部完成,分账结算后商家即可提现至小店绑定的银行账户。
2、如一个订单有多张券,每一张券核销后都会独立发起一次分账结算。

接口说明

请求方式:
post
https://p.wecard.tencent.com/cloudpay/v1/pay/ec/voucher/consume

请求参数

Request
Body 包体
ConsumeRequestNo必填
string

核销单号,核销操作幂等串,商户自定义,请保证在小店下唯一 size最长128字节


Codes选填
array

用户的券code,用户订单详情页面的二维码扫码后获得,查询用户的团购优惠详情接口返回的code。 codes+ sku_id组合和encrypted_codes二者选其一。 对于次卡类型商品,如果传多次相同的code,代表核销多次。 核销多次/多张同时成功或同时失败,不会部分成功。 array_size最大为10

数组子类型:string

EncryptedCodes选填
array

用户订单详情页跳转商家上小程序时可以从path上获取。 codes + sku_id组合和encrypted_codes二者选其一。 对于次卡类型商品,如果传多次相同的encrypted_code,代表核销多次。 核销多次/多张同时成功或同时失败,不会部分成功。 array_size最大为10

数组子类型:string

ConsumeStoreName选填
string

如果需要在C端展示券的核销门店名称,可以选填(仅作为展示) size最长128字节


ConsumeChannel必填
integer

核销渠道, 1=小程序 2=到店。仅供商家用于标记用户核销的途径是通过小程序核销/线下识别二维码核销,平台侧无额外校验规则。


OutStoreId选填
string

核销门店id,商家自定义的门店id(仅作为商家门店标记)


ChannelSubMerchantId必填
string

核销券的商户号(CM开头)

请求示例

{
  "ChannelSubMerchantId": "CM123",
  "ConsumeRequestNo": "233244dfgfdfgsdfgsdf",
  "Codes": [
    "232323",
    "23232323",
    "32434454545"
  ],
  "StoreName": "xxx旗舰店",
  "ConsumeChannel": 1
}

返回参数

Response
Response选填
object

返回示例

{
  "Response": {
    "RequestId": "A8E7B797ADD44C3AA57E87AD7420A725",
    "Result": {
      "VoucherList": [
        {
          "Code": "232323",
          "Status": 2,
          "SendTime": "2023-11-13T14:16:22+08:00",
          "UpdateTime": "2023-11-13T14:16:22+08:00",
          "StartTime": "2023-11-13T14:16:22+08:00",
          "EndTime": "2023-11-13T14:16:22+08:00",
          "ConsumeTime": "2023-11-13T14:16:22+08:00",
          "RefundTime": "2023-11-13T14:16:22+08:00",
          "ProductId": "kbfff",
          "ConsumeStoreName": "xxx旗舰店",
          "VoucherType": 1,
          "VoucherBuyAmount": 0,
          "VoucherActualAmount": 0,
          "TelphoneNo": "fasdf343df34545",
          "Openid": "xsdfs4534543534534",
          "CodeType": 1,
          "OrderId": "23434sdfsdf34342",
          "SkuId": "fdsfdf"
        },
        {
          "Code": "23232323",
          "Status": 2,
          "SendTime": "2023-11-13T14:16:22+08:00",
          "UpdateTime": "2023-11-13T14:16:22+08:00",
          "StartTime": "2023-11-13T14:16:22+08:00",
          "EndTime": "2023-11-13T14:16:22+08:00",
          "ConsumeTime": "2023-11-13T14:16:22+08:00",
          "RefundTime": "2023-11-13T14:16:22+08:00",
          "ProductId": "kbfff",
          "ConsumeStoreName": "xxx旗舰店",
          "VoucherType": 1,
          "VoucherBuyAmount": 0,
          "VoucherActualAmount": 0,
          "TelphoneNo": "fasdf343df34545",
          "Openid": "xsdfs4534543534534",
          "CodeType": 1,
          "OrderId": "23434sdfsdf34342",
          "SkuId": "fdsfdf"
        },
        {
          "Code": "32434454545",
          "Status": 2,
          "SendTime": "2023-11-13T14:16:22+08:00",
          "UpdateTime": "2023-11-13T14:16:22+08:00",
          "StartTime": "2023-11-13T14:16:22+08:00",
          "EndTime": "2023-11-13T14:16:22+08:00",
          "ConsumeTime": "2023-11-13T14:16:22+08:00",
          "RefundTime": "2023-11-13T14:16:22+08:00",
          "ProductId": "kbfff",
          "ConsumeStoreName": "xxx旗舰店",
          "VoucherType": 1,
          "VoucherBuyAmount": 0,
          "VoucherActualAmount": 0,
          "TelphoneNo": "fasdf343df34545",
          "Openid": "xsdfs4534543534534",
          "CodeType": 1,
          "OrderId": "23434sdfsdf34342",
          "SkuId": "fdsfdf"
        }
      ]
    },
    "ErrCode": "SUCCESS",
    "ErrMessage": "成功"
  }
}

腾讯云商付接口文档