View Source WeChat.Card (wechat v0.15.1)

微信卡券

官方文档

Summary

Types

卡券Code码

支持开发者拉出指定状态的卡券列表

卡券类型

typedescription适用核销方式
"CODE_TYPE_QRCODE"二维码显示code适用于扫码/输码核销
"CODE_TYPE_BARCODE"一维码显示code适用于扫码/输码核销
"CODE_TYPE_ONLY_QRCODE"二维码不显示code仅适用于扫码核销
"CODE_TYPE_TEXT"仅code类型仅适用于输码核销
"CODE_TYPE_NONE"无code类型仅适用于线上核销,开发者须自定义跳转链接跳转至H5页面,允许用户核销掉卡券,自定义cell的名称可以命名为“立即使用”

卡券来源

Types

@type card_code() :: String.t()

卡券Code码

一张卡券的唯一标识,核销卡券时使用此串码,支持商户自定义。

@type card_id() :: String.t()
@type card_status() :: String.t()

支持开发者拉出指定状态的卡券列表

  • "CARD_STATUS_NOT_VERIFY" - 待审核
  • "CARD_STATUS_VERIFY_FAIL" - 审核失败
  • "CARD_STATUS_VERIFY_OK" - 通过审核
  • "CARD_STATUS_DELETE" - 卡券被商户删除
  • "CARD_STATUS_DISPATCH" - 在公众平台投放过的卡券
@type card_type() :: String.t()

卡券类型

  • "GROUPON" - 团购券
  • "DISCOUNT" - 折扣券
  • "GIFT" - 礼品券
  • "CASH" - 代金券
  • "GENERAL_COUPON" - 通用券
  • "MEMBER_CARD" - 会员卡
  • "SCENIC_TICKET" - 景点门票
  • "MOVIE_TICKET" - 电影票
  • "BOARDING_PASS" - 飞机票
  • "MEETING_TICKET" - 会议门票
  • "BUS_TICKET" - 汽车票
@type code_type() :: String.t()
typedescription适用核销方式
"CODE_TYPE_QRCODE"二维码显示code适用于扫码/输码核销
"CODE_TYPE_BARCODE"一维码显示code适用于扫码/输码核销
"CODE_TYPE_ONLY_QRCODE"二维码不显示code仅适用于扫码核销
"CODE_TYPE_TEXT"仅code类型仅适用于输码核销
"CODE_TYPE_NONE"无code类型仅适用于线上核销,开发者须自定义跳转链接跳转至H5页面,允许用户核销掉卡券,自定义cell的名称可以命名为“立即使用”
@type cond_source() :: 0 | 1

卡券来源

  • 0 - 为公众平台创建的卡券数据
  • 1 - 是API创建的卡券数据
@type date() :: Date.t() | String.t()
@type is_open() :: boolean()

Functions

Link to this function

check_card_code(client, card_id, card_code, check_consume \\ true)

View Source
@spec check_card_code(
  WeChat.client(),
  card_id(),
  card_code(),
  check_consume :: boolean()
) ::
  WeChat.response()

查询Code - 官方文档

我们强烈建议开发者在调用核销code接口之前调用查询code接口,并在核销之前对非法状态的code(如转赠中、已删除、已核销等)做出处理。

Link to this function

consume_code(client, card_code)

View Source
@spec consume_code(WeChat.client(), card_code()) :: WeChat.response()

核销Code接口 - 官方文档

消耗code接口是核销卡券的唯一接口,开发者可以调用当前接口将用户的优惠券进行核销,该过程不可逆。

Link to this function

consume_code(client, card_id, card_code)

View Source
@spec consume_code(WeChat.client(), card_id(), card_code()) :: WeChat.response()

核销Code接口 - 官方文档

消耗code接口是核销卡券的唯一接口,开发者可以调用当前接口将用户的优惠券进行核销,该过程不可逆。

卡券ID(card_id): 创建卡券时use_custom_code填写true时必填。非自定义Code不必填写

@spec create(WeChat.client(), body :: map()) :: WeChat.response()

创建卡券 - 官方文档

Link to this function

decrypt_code(client, encrypt_code)

View Source
@spec decrypt_code(WeChat.client(), encrypt_code :: String.t()) :: WeChat.response()

Code解码接口 - 官方文档

code解码接口支持两种场景:

  • 商家获取 choos_card_info 后,将 card_idencrypt_code 字段通过解码接口,获取真实 code
  • 卡券内跳转外链的签名中会对 code 进行加密处理,通过调用解码接口获取真实 code
Link to this function

set_pay_cell(client, card_id, is_open)

View Source
@spec set_pay_cell(WeChat.client(), card_id(), is_open()) :: WeChat.response()

设置快速买单 - 官方文档

功能介绍

微信卡券买单功能是微信卡券的一项新的能力,可以方便消费者买单时,直接录入消费金额,自动使用领到的优惠(券或卡)抵扣,并拉起微信支付快速完成付款。

微信买单(以下统称微信买单)的好处:

  • 无需商户具备微信支付开发能力,即可完成订单生成,与微信支付打通。
  • 可以通过手机公众号、电脑商户后台,轻松操作收款并查看核销记录,交易对账,并支持离线下载。
  • 支持会员营销,二次营销,如会员卡交易送积分,抵扣积分,买单后赠券等。
Link to this function

set_self_consume_cell(client, card_id, is_open)

View Source
@spec set_self_consume_cell(WeChat.client(), card_id(), is_open()) ::
  WeChat.response()

设置自助核销 - 官方文档

功能介绍

自助核销与扫码/输码核销互为补充,卡券商户助手通过扫码/输码完成核销的同时,也确保了用券的真实性,适合有强对账需求的商户使用;而自助核销由用户发起,全程由用户操作,适合对账需求不强的商户使用。

目前,自助核销可能适合以下场景使用:

  • 不允许店员上班期间带手机;
  • 高峰期店内人流量大,扫码/输码核销速度不能满足短时需求;
  • 会议入场,短时有大量核销任务;