代金券API

产品介绍

服务商/商户可通过接入微信支付营销API, 在服务商/商户已有的平台实现制券、发券、查券、修改等完整的流程。同时可享受返佣所获得的收益, 及使用微信支付代金券的特有能力(包括支持在微信场景投放、拥有更好的触达、有品牌曝光、更好的服务连接、强大的安全防刷机制）。

开发指引

业务流程时序图

创建代金券批次API

通过调用此接口可创建代金券批次, 包括预充值&免充值类型。

发放代金券API

商户平台/API完成制券后, 可使用发放代金券接口发券。通过调用此接口可发放指定批次给指定用户, 发券场景可以是小程序、H5、APP等。

激活代金券批次API

制券成功后, 通过调用此接口激活批次, 如果是预充值代金券, 激活时会从商户账户余额中锁定本批次的营销资金。

暂停代金券批次API

通过此接口可暂停指定代金券批次。暂停后, 该代金券批次暂停发放, 用户无法通过任何渠道再领取该批次的券。

重启代金券批次API

通过此接口可重启指定代金券批次。重启后, 该代金券批次可以再次发放。

条件查询批次列表API

通过此接口可查询多个批次的信息, 包括批次的配置信息以及批次概况数据。

查询批次详情API

通过此接口可查询批次信息, 包括批次的配置信息以及批次概况数据。

查询代金券详情API

通过此接口可查询代金券信息, 包括代金券的基础信息、状态。如代金券已核销, 会包括代金券核销的订单信息(订单号、单品信息等）。

查询代金券可用商户API

通过调用此接口可查询批次的可用商户号, 判断券是否在某商户号可用, 来决定是否展示。

查询代金券可用单品API

通过此接口可查询批次的可用商品编码, 判断券是否可用于某些商品, 来决定是否展示。

根据商户号查用户的券

可通过该接口查询用户在某商户号可用的全部券, 可用于商户的小程序/H5中, 用户"我的代金券"或"提交订单页"展示优惠信息。无法查询到微信支付立减金。本接口查不到用户的微信支付立减金(又称“全平台通用券”）, 即在所有商户都可以使用的券, 例如: 摇摇乐红包

下载批次核销明细API

可获取到某批次的核销明细数据, 包括订单号、单品信息、银行流水号等, 用于对账/数据分析。

下载批次退款明细API

可获取到某批次的退款明细数据, 包括订单号、单品信息、银行流水号等, 用于对账/数据分析。

设置消息通知地址API

用于设置接收营销事件通知的URL, 可接收营销相关的事件通知, 包括核销、发放、退款等。

核销事件回调通知 API

图片上传 API

通过本接口上传图片后可获得图片 url 地址。图片 url 可在微信支付营销相关的 API 使用, 包括商家券、代金券、支付有礼等。