管理会员卡
(接上)
8.管理会员卡
8.1拉取会员信息(积分查询)接口
8.2更改会员卡信息接口
8.3设置跟随推荐接口
8.4设置支付后投放卡券(支付即会员)
8.5设置会员卡支持微信支付刷卡
8.6其他管理接口
9.统计会员卡数据
10.我是第三方
# 8 管理会员卡
# 8.1 拉取会员信息(积分查询)接口
接口说明
支持开发者根据card_id和Code查询会员信息,包括激活资料、积分信息以及余额等信息。
接口调用请求说明
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/membercard/userinfo/get?access_token=TOKEN
参数说明
POST数据
{
"card_id": "pbLatjtZ7v1BG_ZnTjbW85GYc_E8",
"code": "916679873278"
}
返回数据
{
"errcode": 0,
"errmsg": "ok",
"openid": "obLatjjwDolFjRRd3doGIdwNqRXw",
"nickname": "Fourier",
"membership_number": "316510891298",
"bonus": 460,
"sex": "MALE",
"user_info": {
"common_field_list": [
{
"name": "USER_FORM_INFO_FLAG_MOBILE",
"value": "15521328888"
},
{
"name": "USER_FORM_INFO_FLAG_NAME",
"value": "微信"
}
],
"custom_field_list": []
},
"user_card_status": "NORMAL"
}
# 8.2 更改会员卡信息接口
接口说明
支持更改会员卡卡面信息以及卡券属性信息。
接口调用请求说明
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/update?access_token=TOKEN
参数说明
POST数据
{
"card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
"member_card": {
"background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
"base_info": {
"logo_url": "http:\/\/mmbiz.qpic.cn\/uploads\/allimg\/120216\/1_120216214725_1.jpg",
"color": "Color010",
"notice": "使用时向服务员出示此券",
"service_phone": "020-88888888",
"description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食\n餐前不可打包,餐后未吃完,可打包\n本团购券不限人数,建议2人使用,超过建议人数须另收酱料费5元/位\n本单谢绝自带酒水饮料",
"location_id_list": [
123,
12321,
345345
]
},
"bonus_cleared": "aaaaaaaaaaaaaa",
"bonus_rules": "aaaaaaaaaaaaaa",
"prerogative": "",
"auto_activate": true,
//也可以填写wx_activate"activate_url":""
}
}
支持修改字段:
base_info字段:
会员卡专属字段修改:
特别注意,以下支持更新的字段不在基本信息base_info的结构中。
返回数据说明
数据示例:
{
"errcode":0,
"errmsg":"ok",
"send_check":true
}
开发者注意事项注
1. 更改卡券的部分字段后会重新提交审核,详情见字段说明,更新成功后可通过调用查看卡券详情接口核查更新结果;
2. 仅填入需要更新的字段,许多开发者在调用该接口时会填入brandname等不支持修改的字段,导致更新不成功。
3. 调用该接口后更改卡券信息后,请务必调用*首页验证是否已成功更改。*
# 8.3 设置跟随推荐
功能介绍
支持开发者在积分、余额变动、会员卡激活等消息底部,配置优惠券或设置跳转外链URL,具体形式如下图,可以是URL也可以是一张卡券。
8.3.1 设置跟随推荐接口
接口说明
开发者可以通过该接口设置会员激活以及发生交易(积分变动、余额变动)后赠送优惠券。
接口详情
接口调用请求说明
http请求方式: POSTURL:https://api.weixin.qq.com/card/update?access_token=TOKEN
参数说明
使用消息配置卡券
{
"card_id": "pbLatjkoa7luhR3zIBjtQiaYtnz4",
"member_card": {
"activate_msg_operation": {
//若指定的是积分、余额等变动消息赠券,则为modify_msg_operation
"url_cell": {
"card_id_list": [
"pbLatjhcI6XUxJWA0Au3Gaq5eFPs"
],
"end_time": 1492724561,
"text": "恭喜你获得一张50元代金券",
"url": "www.qq.com"
}
}
}
}
字段说明
返回数据
{
"errcode":0,
"errmsg":"ok"
}
字段说明
开发者注意事项
1.支持一张会员卡同时设置积分/余额变动消息赠券和激活赠券,开发者须分开设置;
2.开发者若填写了card_id_list后,若再填写url字段则card_id_list内容失效;
3.若开发者设置了url,则须支持在url上领券,否则会被视为恶意营销处罚。
# 8.4 设置支付后投放卡券
8.4.1 设置支付后投放卡券接口
开通微信支付的商户可以设置在用户微信支付后自动为用户发送一条领卡消息,用户点击消息即可领取会员卡/优惠券。
目前该功能仅支持微信支付商户号主体和制作会员卡公众号主体一致的情况下配置,否则报错。开发者可以登录
“公众平台”-“公众号设置”、**“微信支付商户平台首页”**插卡企业主体信息是否一致。
接口说明
支持商户设置支付后投放卡券规则,可以区分时间段和金额区间发会员卡。
接口调用请求说明
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/paygiftcard/add?access_token=TOKEN
参数说明
设置支付即会员时POST数据
{
"rule_info": {
"type": "RULE_TYPE_PAY_MEMBER_CARD",
"base_info": {
"mchid_list": [
"123",
"456"
],
"begin_time": 1480317217,
"end_time": 1580317217
},
"member_rule": {
"card_id": "abcdefg",
"least_cost": 2,
"max_cost": 20000,
"jump_url": "www.qq.com"
}
}
}
字段说明
rule_info是一个JSON结构,包含以下字段
base_info是一个JSON结构,包含以下字段
member_rule是一个JSON结构,当前设置为支付即会员时填入,包含以下字段
返回数据说明
数据示例:
{
"errcode": 0,
"errmsg": "ok",
"rule_id": 1231243,
"fail_mchid_list": [
{
"mchid": "111",
"errcode": 23112,
"errmsg": "err",
"occupy_rule_id": 12332123,
"occupy_appid": "appid"
}
]
"succ_mchid_list": [
"123",
"456"
]
}
开发者注意事项
会员卡领卡消息针对单个新用户仅发送一次,若该用户已经接收或者已经领取过会员卡则不会重复发送;
通过该规则设置的card_id的制券appid主体必须和当前mch_id的主体一致,否则报错72001;
开发者可以登录**“公众平台”-“公众号设置”、“微信支付商户平台首页”**插卡企业主体信息是否一致;
3.仅支持会员卡类型的卡券,否则报错:72003;
4.设置支付即会员时,须确认调用接口的appid须为制卡的appid,否则报错:72002;
5.须保证mchid之前没有被其他appid设置过,否则报错72004,须先删除支付即会员规则后调用;
6.单次仅限设置10个mchid,若超过10个请多次调用本接口。
Q&A
Q:我已有商户号和公众号,如何知道两者的主体是否一致?
A:可在“公众平台”-“公众号设置”、“微信支付商户平台首页”查看企业主体信息是否一致。
**Q:我们是集团和子公司的关系,希望在子公司商户号下支付后,发放集团的公众号创建的会员卡。但是用子公司的appid为子公司的mchid配置规则,设置集团公司的card_id报错72002,怎么办?**
A:对于这种情况,可以登录微信开放平台 (https://open.weixin.qq.com/) ,将所有子公司的公众号绑定在总公司的第三方平台账号下方,完成绑定后可实现集团号间发卡的配置,并相互识别会员身份(UnionID机制)。
Q:我们是集团和子公司的关系,希望在子公司商户号下支付后,发放集团的公众号创建的会员卡。但是用集团的appid为子商户的mchid配置规则,设置集团公司的card_id报错72001,怎么办?
A:解决方法同上
8.4.2 删除支付后投放卡券规则接口
删除之前已经设置的支付即会员规则。
接口说明
支持商户删除之前设置的规则id
接口调用请求说明
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/paygiftcard/delete?access_token=TOKEN
参数说明
POST数据
{ "rule_id": 1233}
字段说明
返回数据说明
数据示例:
{
"errcode": 0,
"errmsg": "ok"
}
8.4.3 查询支付后投放卡券规则详情接口
接口说明
可以查询某个支付即会员规则内容。
接口调用请求说明
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/paygiftcard/getbyid?access_token=TOKEN
参数说明
POST数据
{ "rule_id": 11233}
字段说明
返回数据说明
数据示例:
{
"errcode": 0,
"errmsg": "ok",
"rule_info": {
"type": "RULE_TYPE_PAY_MEMBER_CARD",
"base_info": {
"mchid_list": [
"123",
"456"
],
"begin_time": 1480317217,
"end_time": 1580317217,
"status": "RULE_STATUS_OK",
"create_time": 1480317217,
"update_time": 1480317217
},
"member_rule": {
"card_id": "abcdefg",
"least_cost": 2,
"max_cost": 20000,
"jump_url": "www.qq.com"
}
}
}
8.4.3批量查询支付后投放卡券规则接口
接口说明
可以批量查询某个商户支付即会员规则内容
接口调用请求说明
HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/paygiftcard/batchget?access_token=TOKEN
参数说明
POST数据
{
"type": "RULE_TYPE_PAY_MEMBER_CARD",
"effective": true,
"offset": 0,
"count" : 1
}
字段说明
返回数据说明
数据示例:
{
"errcode": 0,
"errmsg": "ok",
"total_count": 4,
"rule_list": [
{
"type": "RULE_TYPE_PAY_MEMBER_CARD",
"base_info": {
"mchid_list": [
"123",
"456"
],
"begin_time": 1480317217,
"end_time": 1580317217,
"status": "RULE_STATUS_OK",
"create_time": 1480317217,
"update_time": 1480317217
},
"member_rule": {
"card_id": "abcdefg",
"least_cost": 2,
"max_cost": 20000,
"jump_url": "www.qq.com"
}
}
]
}
注意事项:
1.以上为支付即会员新接口协议,旧接口依然可以调用,旧协议见:
https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1481363811&version=1&lang=zh_CN&platform=2
# 8.5 设置会员卡支持微信支付刷卡
通过接口创建支持刷卡类型的会员卡,用户点击快速买单后即可拉出刷卡界面进行支付。以下为示意图:
8.5.1 创建会员卡支持微信支付刷卡
商户可以创建一张会员卡支持微信支付刷卡,须在创建会员卡接口的JSON中加入以下字段:
{
"card": {
"card_type": "MEMBER_CARD",
"member_card": {
"base_info": {
"pay_info":
{
"swipe_card":
{
"is_swipe_card":true
}
}
}
}
}
}
详情请见:创建会员卡
8.5.2 更新会员卡支持微信支付刷卡
商户可以更新已有会员卡支持微信支付刷卡,须在更新会员卡接口的JSON中加入以下字段:
{
"card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
"member_card": {
"base_info": {
"pay_info":
{
"swipe_card":
{
"is_swipe_card":true
}
}
}
}
}
详情请见:管理会员卡
开发者注意事项
1.设置该功能之前,请确认自己是否开通了微信支付,否则接口报错(开通微信支付)
2.通过接口设置会员卡拉出刷卡后,当用户进行支付时通过授权码查询OPENID接口https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_13&index=9获取用户openid,
再调用获取用户领取卡券接口http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&token=&lang=zh_CN获取该openid的会员身份,并进行相应的批价。
3.仅微信6.3.18及以上版本支持会员卡拉出刷卡支付,低于6.3.18的客户端版本将提示用户升级。
# 8.6 其他接口
8.6.1 修改库存接口
调用修改库存接口增减某张卡券的库存,详情见:管理卡券
8.6.2 查询code接口
开发者可以通过该接口查询会员卡的基本信息,包括领取人的OpenID、会员卡状态,详情见:管理卡券
8.6.3 获取用户已领取的卡券
支持开发者调用该接口获取指定用户卡包中属于该appid下的卡券,详情见:管理卡券
8.6.4 查看卡券详情
调用该接口可查询card_id创建是传入的字段详情及卡券所处审核状态。详情见:管理卡券
8.6.5 批量查询卡列表
开发者可以通过该接口拉取当前商户(appid)下所有的卡券列表,用于卡券管理,详情见:管理卡券
8.6.6 删除会员卡
开发者可以通过该接口删除商户列表的card_id,用于卡券管理,详情见:管理卡券
8.6.7 设置会员卡失效接口
开发者可以通过该接口将某一个用户的某一张卡券置为失效,用于退款等场景,详情见:管理卡券
# 9 统计会员卡数据
开发者可以通过该接口拉取会员卡数据,详情见:管理卡券
# 10 我是第三方
第三方可以为接入的商户代制会员卡,详情参考:第三方开发者模式