微信支付(商户平台)卡券开发文档

时间:2024-04-08 09:45:06

简介

除了微信公众平台提供的微信卡券之外,微信支付商户平台也提供卡券相关功能,其中包含代金券商家券两大类。卡券现在用的不是太多了,更多的是使用微信支付的商家券和代金券;

微信支付卡券与微信公众平台卡券区别

  1. 微信公众平台卡券:不能在支付时使用券,必须先核销,商家载判断这个券满多少减多少,再付多少钱。核销规则由商家自行定义

  2. 微信支付商家券:与微信公众平台卡券核销规则一致(不过多出一种核销方式:支持跳转付款码支付核销);

  3. 微信支付代金券:可以在支付时候使用,统一下单使用优惠计算。核销是微信支付帮忙做的

代金券

微信支付代金券业务是基于微信支付,为了协助商户方便地实现营销优惠措施。针对部分有开发能力的商户,微信支付提供通过API接口实现运营代金券的功能。

代金券分类

预充值代金券

活动创建者需要把优惠的预算,提前充值到商户余额中,活动中产生的优惠资金从余额中扣除,最终会跟用户实际支付的资金一起结算给商户。

商户实收金额=用户订单金额(例如:满100减10. 指订单金额100元,用户实付90元,商户实收100元)。
微信支付(商户平台)卡券开发文档

特点

  1. 优势:不影响商户实收,对账方便/免开发,配置即可使用;
  2. 劣势:占用资金,影响资金流动性/涉及较为繁琐的财务税务流程/渠道商不支持

注意

  • 预充值资金占用以领券资金核算,即当用户领券时就会占用预充值金额

  • 在活动中用户使用代金券产生的优惠资金时,会从商户余额中扣除,最终跟用户实际支付资金一起结算给商户

  • 待核销周期结束后,已经领券但未核销的资金将会返还至预充值账户,领券金额所占用资金在核销期结束可提取

免充值代金券

活动创建者无需提前充值资金即可创建活动,用户享受优惠时,直接从当前交易商户订单实收金额中扣除。最终只跟商户结算用户实际支付的资金(免充值开通指引) 。

商户实收金额 = 用户订单金额-代金券优惠金额(例如:满100减10. 指订单金额100元,用户实付90元,商户实收90元。用户领券后,在支付中直接核销10元
微信支付(商户平台)卡券开发文档

特点

  1. 优势:不占用资金;
  2. 劣势:影响商户实收;

注意

  • 需要升级接口(服务商开通能力→服务商打通接口→商户开通能力→商户授权服务商→免充值代金券/立减折扣能力→商户开通代金券/立减折扣能力)

发券渠道

二维码发券

微信支付代金券二维码发券,仅适用于商户平台操作,不支持API接口。具体操作见下方【操作指引—商户平台操作—发放代金券】。

营销活动发券

微信支付代金券营销活动发券,仅适用于商户平台操作,不支持API接口。具体操作见下方【操作指引—商户平台操作—发放代金券】。

高级API接口发券

微信支付代金券API接口发券,具体操作见下方【操作指引—商户平台操作—发放代金券】。

核销方式

支付中自动核销券

目前微信支付代金券仅支持支付中自动核销券

  • 自动触发代金券使用

    如果创建代金券时候,不指定goods_tag(订单优惠标记),用户领取后只要支付金额满足条件就会触发代金券的使用

    前提需要在后台开通满立减活动,然后用户领取券,满足支付符合规则自动发。自动核销。

  • 手动触发代金券使用

    如果创建代金券时候,指定了goods_tag(订单优惠标记)限定商品订单可用,则微信统一下单时需要同时指定此goods_tag且支付金额满足代金券使用条件才可使用,否则无法使用指定了订单优惠标记的代金券(注意:统一下单时goods_tag只要有一个命中代金券goods_tag就会触发)。

操作指引

微信为商户/服务商提供商户平台以及API接口两种方式操作代金券,具体包含:

  • 创建代金券批次:可创建代金券类型包含预充值免充值代金券两种类型;
  • **代金券批次:制券成功后,**代金券才可进行发放(如果是预充值模式,**时从商户账户余额中锁定本批次营销资金);
  • 发放代金券:**的代金券可进行发放,发放方式包含:二维码发放营销活动发放API高级接口发放三种方式。
  • 支付中自动核销券:用户领券后,在支付过程中自动核销券中所示金额(实付金额=订单总金额-代金券金额)。当一个券核销后,微信支付侧会推送通知给商户/服务商的服务器(前提是商户已设置接受通知URL地址)。通知信息包含券ID、核销信息、单品信息等。
  • 管理代金券:用户可对代金券进行查询、修改、暂停发放等管理操作。
  • 营销事件推送:商户在微信商户平台开通营销事件推送能力,即可接受到相关通知。
开发前准备
开通代金券权限

使用商户平台代金券功能,需要开通代金券权限。操作路径:【登录微信支付商户平台——>产品中心——>预充值代金券——>开通】。

下载API证书

商户在使用代金券时,需要安装证书,请在商户平台下载证书。

注意:

  1. 可调用接口的角色:每个接口的限制不同,可参考每个接口的规则。
  2. 调用时mchid和APPID需要有绑定关系,可在【微信支付商户平台—>产品中心—>开发配置】进行绑定,APPID和openid需要有对应关系。
商户平台操作
创建代金券

商户登录微信支付商户平台创建代金券批次(操作路径:【微信支付商户平台—>营销中心—>创建全场/单品代金券】)。具*券信息可参考《创建代金券》。

**代金券

待**的代金券都存放在管理代金券-草稿箱中。点击各批次右上角**按钮可查看详情并**,**后的代金券将迕入运营中。已**的代金券在有效期之内或暂停前都可以发放。

注:在**前,请确保账户内有足够的预算,且只有拥有****营销活动**权限的账号才能够**代金券

发放代金券

运营中的代金券批次有二维码营销活动高级接口 3 种发放方式。其中前两种是通过商户平台发券(如该代金券已开启卡包功能,用户可将代金券添加到卡包)。

  • 二维码发券

    点击代金券发放概况中的查看发放方式,可下载代金券二维码。每个批次的代金券对应一个唯一的二维码。此二维码在代金券有效期内有效,用户扫描二维码后,可即时领取到一张该批次的代金券。如果该批次已达到发放上限或可用余额不足(可用余额不足停止发放仅涉及充值券),则提示活动已结束。

  • 营销活动发券

    微信支付商户平台还提供了营销活动工具,可实现用户在本商户或指定商户内支付满一定金额后,主动向其发放一张指定的代金券(详情可查看满额送营销活动文档)。

管理代金券

微信商户平台提供管理代金券功能,商户可对发放的代金券进行:查看代金券状态修改暂停发放查看发放和消耗记录。具体操作可参考《管理代金券》。

API接口操作
创建代金券

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

**代金券

制券成功后,通过调用此接口**批次。

注意:

如果是预充值代金券,**时会从商户账户余额中锁定本批次的营销资金

发放代金券

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

注意:

  1. 通过接口发放的代金券不会自动进入微信卡包,如需申请自动插入卡包的能力,可向对接的微信支付行业运营同事了解申请流程(仅向部分商户开放)。代金券发券成功后,即使不插入微信卡包,也不会影响使用(支付时候自动核销)。
  2. 商户默认只允许发放本商户号(调用发券接口的商户号)创建的代金券,如需发放其他商户商户创建的代金券,请参考Q1
管理代金券

API接口提供代金券管理接口包含:

  • 暂停代金券批次:暂停后,该代金券批次暂停发放,用户无法通过任何渠道再领取该批次的券。

  • 重启代金券批次:重启后,该代金券批次可再次发放。

  • 条件查询代金券批次列表:可查询多个批次的代金券信息,包括批次的配置信息以及批次概况数据。

  • 查询代金券批次详情:包括批次的配置信息以及批次概况数据。

  • 查询代金券详情:该接口查询具体一张代金券详情,包括代金券的基础信息、状态。如代金券已核销,会包括代金券核销的订单信息(订单号、单品信息等)。

  • 查询代金券可用商户:查询代金券批次的可用商户号,判断券是否在某商户号可用,来决定是否展示。

  • 查询代金券可用单品:可查询批次的可用商品编码,判断券是否可用于某些商品,来决定是否展示。

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

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

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

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

具体接口使用明细可参见《代金券管理API接口》。

商家券

微信支付商家券类似于微信商户公众平台的免费卡券,商家可在微信支付允许的范围内通过该功能实现商家优惠券信息的生成、下发、领取、核销的闭环,并使用数据对账、券信息查询等配套功能完成商家功能完成商家券的管理。

注意:

微信支付商家券功能目前暂时仅提供API接口方式实现(仅适用于有开放能力的商户),暂不支持商户平台页面配置管理功能

商家券分类

当前商家券支持的类型有:满减券折扣券换购券三种优惠类型(类型相对公众平台的卡券较少无团购券)

满减券

满X元减X元(例如:满10元减5元券),商户可在券的适用范围字段里向用户说明,券的适用商品情况(例如:全场商品适用,特价商品除外XX品牌商品适用)。

折扣券

满X元享受X折,商户可在券的适用范围字段里向用户说明,券的适用商品情况(例如:全场商品适用,特价商品除外或XX品牌商品适用),包装出全场折扣券或者指定单品折扣券。

换购券

满X元换商品,商户可以用换购券包装出时尚百货常见的小样(单品)免费兑换券(例如:2元换可乐)或减至券;商户可在券的适用范围字段里向用户说明,券的适用商品情况(例如:XX品牌商品适用,不适用与XX商品)。

发券渠道

商家自有流量场景

有一定的开发量,适用于用开发能力的商家。微信支付支持在商家的小程序(小程序发券插件)H5网页(JS-API发券)中派发商家券。

具体发券逻辑参见下面【操作逻辑—>API接口操作—>发放商家券】

注意:

  1. 小程序发券插件,该插件当前仅支持发放【微信支付商家券】 , 暂不支持发放【微信支付代金券】,请各商户特别留意
  2. 使用小程序发放商家券,商家的小程序需要先申请开通该发券插件的权限后,才可进行开发。申请审核1个工作日完成。操作路径:【商家小程序—>设置—>第三方设置—>插件管理—>添加插件】
微信支付平台流量场景

微信支付支持在支付有礼(用户在商家支付成功页)、附近发券(用户面对面支付成功页)中派发商家券。对应活动创建有Pay平台创建以及API接口创建,分别适用于无开发意愿商家和有开发意愿商家。

核销方式

线上小程序核销(MINI_PROGRAMS)

用户点立即使用,跳转至商家小程序(需要添加小程序appid和path)。商家系统后台请求查询到当前用户微信卡包内对应的所有商家券信息,再跟商家自己的优惠规则进行使用判断,然后再调用核销接口,流转用户微信卡包内的商家券状态为已核销

线下滴码核销(OFF_LINE)

用户到商家线下门店,进入卡包找到指定卡券,点击立即使用,跳转展示券二维码详情。向商家展示商家券使用Code二维码,商家线下扫码枪识别Code信息,调用后台核销接口,流转用户微信卡包内对应商家券状态为已核销

注意:用户是否满足优惠使用门槛条件,以及对应优惠金额或商品均由商家系统自行判断。如果满足对应要求,商家系统再请求微信支付系统核销商家券

微信支付付款码核销(PAYMENT_CODE)

点击立即使用跳转至微信支付钱包付款码。具体核销流程可参见文档尾部扩展—《商家券付款码核销流程

用户自助核销(SELF_CONSUME)

点击立即使用跳转至用户自助操作核销界面(当前暂不支持用户自助核销)。

操作指引

开发前准备
证书&签名准备

证书和签名的详细内容请参见:接口规则

API**设置

API**的详细内容请参见:APIv3证书和**

下载API证书

商户在使用商户券时,需要安装证书,请在商户平台下载证书。具体操作请参见:如何获取API证书

API接口操作
创建商家券

商户/服务商可以通过该接口创建商家券/为有需求的商户创建商家券。

发放商家券
核销用户券

在用户满足优惠门槛后,商家/服务商可通过该接口核销用户微信卡包中具体某一张商家券。

管理商家券

微信支付商家券提供商家券管理操作如下:

  • 根据过滤条件查询用户券:商户/服务商自定义筛选条件(如创建商户号、归属商户号、发放商户号等),查询指定微信用户卡包中满足对应条件的所有商家券信息。

  • 查询用户单张券详情:商户/服务商可通过该接口查询微信用户卡包中某一张商家券的详情信息。

  • 上传预存code:商家券的Code码可由微信后台随机分配,同时支持商户自定义。如商家已有自己的优惠券系统,可直接使用自定义模式。即商家预先向微信支付上传券Code,当券在发放时,微信支付自动从已导入的Code中随机取值(不能指定),派发给用户。

  • 设置商家券事件通知地址:用于设置接收商家券相关事件通知的URL,可接收商家券相关的事件通知、包括发放通知等。需要设置接收通知的URL,并在商户平台开通营销事件推送的能力,即可接收到相关通知。

    营销事件推送:点击开通产品权限。 由商家券批次创建方登录Pay平台,操作开通。

    注意: 仅可以收到由商户自己创建的批次相关的通知。

  • 查询商家券事件通知地址:通过调用此接口可查询设置的通知URL。

    注意:仅可以查询由请求商户号设置的商家券通知url。

  • 关联订单信息:将有效态(未核销)的商家券与订单信息关联,用于后续参与摇奖&返佣激励等操作的统计。

    注意:仅对有关联订单需求的券进行该操作。

  • 取消关联订单信息:取消商家券与订单信息的关联关系。

    注意:建议取消前调用查询接口,查到当前关联的商户单号并确认后,再进行取消操作。

扩展

微信商户支付平台说明文档

预充值资金管理

微信支付商户平台的普通可用余额,与商户的交易收入不同,此项资金由商户主动充值,可在创建预充值的代金券、立减与折扣活动、发放现金红包和向用户转账时使用。

每**一个预充值代金券或预充值立减或折扣优惠活动,都将在余额中扣除相应活动预算,活动结束后未消耗的预算会退回可用余额

商家券付款码核销流程

商家券在创建时候可选择核销方式,如果选择PAYMENT_CODE,则用户点击立即使用时会跳转至微信支付付款码页面,商家扫码后,需要自己做逻辑处理:

  1. 查询当前用户所有该商家优惠券;
  2. 根据用户购物商品,判断优惠规则,扣减优惠券;
  3. 根据扣减优惠券后需用户实付金额,发起微信支付统一下单请求;
  4. 用户支付成功后,商家核销掉对应抵扣的商家券;

微信支付(商户平台)卡券开发文档

如何跨商户号发券

商户号A默认只允许发放本商户号创建的代金券,跨商户号发券的场景是:A商户号(一般是服务商)制券,在B商户号的场景(例如:小程序)中发券。如需发放商户号A创建的代金券,需要具体步骤:

  1. A商户号开通跨商户发券制券商户号的白名单;
  2. B商户号开通商户发券商户号的白名单;
  3. 然后A商户号开始制券,制券时要把B添加为可发券商户
  4. 然后使用B的商户号调用发券接口,在和B商户号有绑定关系的APPID对应场景(例如:公众号、小程序)中发券就可以了;

申请流程

  • 需要先开通跨商户号发券权限。发邮件给[email protected][email protected],说明申请原因、制券的商户号、发券商户号。
  • 配置批次的时候把可发券商户号填发券商户,然后调用发券接口即可。

发券接口请参考:
产品文档:https://docs.qq.com/doc/DT1B4dUNjUG1oYlZ0
开发文档:https://pay.weixin.qq.com/wiki/doc/apiv3/convention.php?chapter=13_1