摇优惠-核销组件(通过openid发券)开发指引
更新时间:2025.06.181、背景介绍
为解决在摇一摇有优惠场景用户“领取不到券”以及“领券后找不到可用商品“的两大核心问题,平台侧提供标准化核销组件,标准化领取与核销体验链路,最终提升用户领券率与领取核销率。
领取不到券:通常是用户在商家小程序未登录正确的领券账号,导致无法找到优惠券。
领券后找不到可用商品:通常为单品或品类券,用户登录小程序后未能及时找到优惠单品,导致用户流失。
2、组件介绍
组件页面无需商家开发,商家根据规范在用户用券场景调起核销组件,串接可用单品。
3、如何开通商家券核销组件权限
需联系贵司对接的微信支付行业运营负责人申请。
4、系统版本要求
开发者可通过调用wx.openBusinessView方式在商户小程序中打开商家券核销组件,引导用户核销商家券。
接口兼容:微信 >= 8.0.30&小程序版本库 >= 2.28.1,低版本需提示用户升级到最新的微信版本。
5、 接入流程
5.1、摇一摇-领券事件回调通知(如何获取用户openid)
1、创建商家券接口中设置notify_config.notify_appid,领券事件回调通知接口会按照此appid设置openid。
2、对领券事件回调通知的resource.ciphertext进行解密,得到的资源对象示例(见第 6 行,解密后获取领券用户 openid)。
5.2、如何调用商家券核销组件
核销组件接口调用请参考摇一摇有优惠核销组件API
「摇一摇有优惠」跳转商家小程序的路径query会增加以下属性
属性 | 类型 | 说明 |
couponCode | string | 券的唯一标识 |
stockId | string | 批次号 |
action | string | 操作标识 wxpayCouponUse:商家券核销操作标识 |
accountType | string | 领券用户类型标识 |
调用微信支付商家券核销组件需满足以下条件:
参数校验:从路径 query 参数获取 couponCode(券的唯一标识)
身份验证:
商家使用 couponCode 和 stockId 匹配用户 领券 openid。
通过商家服务端接口获得当前用户小程序登陆openid。
比对 领券 openid 和 登录 openid 的一致性,按照协议设置 authState(用户账户登录状态,见本文档5.3 商家调起商家券组件接口说明,extraData 参数 authState 的说明 )
操作标识:路径 query 参数中 action 字段值为 wxpayCouponUse(商家券核销操作标识)
用户标识:路径 query 参数中 accountType 字段值为 accoutTypeOpenid(领券用户类型标识)
示例
|
5.3 商家调起商家券组件接口说明
开发者可通过调用 wx.openBusinessView 方式在本小程序打开商家券核销组件,引导用户核销商家券。
接口名称:wx.openBusinessView
接口兼容:微信 >= 8.0.30&小程序版本库 >= 2.28.1,低版本需提示用户升级到最新的微信版本。
接口参数
属性 | 类型 | 必填 | 说明 |
businessType | string | 是 | 固定配置:wxpayCouponUse |
extraData | object | 是 | 用于向组件传递商家券信息 |
extraData参数
属性 | 类型 | 必填 | 说明 |
couponCode | string | 是 | 券的唯一标识 商品详情页跳转商家小程序的路径query会增加该属性,开发者可通过小程序页面query参数获取此值。 |
stockId | string | 是 | 批次号 商品详情页跳转商家小程序的路径query会增加该属性,开发者可通过小程序页面query参数获取此值。 |
authState | string | 是 | 用户登录账号的状态 用户正确登录账号:verified 用户登录错误账号:invalidCredentials 用户未登录/注册:unauthenticated
见本文档 5.2、如何调用商家券核销组件 |
success回调结果参数
属性 | 类型 | 必填 | 说明 |
extraData | object | 是 | 用于向组件传递商家券信息 |
extraData参数
属性 | 类型 | 必填 | 说明 |
action | string | 否 | 用户动作 selectProduct: 选择商品 auth: 注册/登录 closePage: 关闭页面 switchAccount: 更换登录账号 selectGlobalCoupon: 选择全场券 |
productPath | string | 否 | 用户选择的商品路径 当用户选择商品,会在success回调返回商品路径,由开发者自行跳转 |
errMsg | string | 否 | 错误信息 |
调用示例
5.4 商家处理接口回调参数说明
回调action | 商家操作说明 |
selectProduct: 选择商品 | 根据返回的productPath跳转至对应商品详情页 |
auth: 注册/登录 | 拉起商家小程序微信账号登录流程(由商家自定义页面跳转路径) |
switchAccount: 更换登录账号 | 拉起商家小程序切换账号登录流程(由商家自定义页面跳转路径) |
selectGlobalCoupon: 选择全场券 | 跳转商家货架选品页面(由商家自定义页面跳转路径) |
closePage: 关闭页面 | 无需操作 |