查询用户会员卡信息

更新时间:2024.09.20

通过此接口可查询指定用户会员卡的信息,如会员积分、储值余额、开卡信息等

接口说明

支持商户:【普通商户】

请求方式:【GET】/v3/marketing/membercard-open/cards/{card_id}/codes/{code}

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


path 路径参数

card_id  必填 string(32)

【会员卡模板ID】商户创建微信会员卡模板成功后系统返回的会员卡模板ID


code  必填 string(32)

【会员卡code】会员在一个card_id下的唯一标志,用户领取会员卡后获得的code

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/membercard-open/cards/pbLatjvWOibDc5-TBnbUk1pD12o0/codes/478515832665 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

card_id  选填 string(32)

【会员卡模板ID】商户创建微信会员卡模板成功后系统返回的会员卡模板ID


code  选填 string(32)

【会员卡code】会员在card_id下的唯一标识,用户领取会员卡后获得的code


openid  选填 string(128)

【用户标识】用户在会员卡绑定品牌AppID下的唯一标识,如通过手机号同步会员身份且用户未领取到卡包,无法查询该字段


membership_number  选填 string(32)

【会员卡编号】 在用户会员卡上展示的会员卡编号,默认使用会员卡code作为membership_number。只能录入数字/英文/半角标点。商家可通过修改用户单张会员卡信息更新


level  选填 string(5)

【用户等级】用户会员等级


nickname  选填 string(32)

【微信昵称】用户的微信昵称,如通过手机号同步会员身份且用户未领取到卡包,无法查询该字段


head_image_url  选填 string(128)

【微信头像URL】用户的微信头像URL,如通过手机号同步会员身份且用户未领取到卡包,无法查询该字段


background_picture_url  选填 string(128)

【会员卡背景图】 商家给当前用户设置的会员卡背景图。仅支持通过《图片上传API》接口获取的图片URL地址。支持JPG/JPEG/PNG格式,且图片小于1M。


balance  选填 int

【用户储值余额】用户储值的最新余额,单位分


user_card_status  选填 string(16)

【用户会员卡状态】用户当前的卡状态

  • NOT_ACTIVATE: 未激活

  • EFFECTIVE: 生效中

  • EXPIRE: 已过期

  • UNAVAILABLE: 已失效

  • DELETE: 已删除

  • IMPORTED: 会员身份已通过手机号或OpenID导入,但用户未领取到微信卡包


user_information  选填 object

【用户开卡时填写的个人信息】用户开卡时填写的个人信息

属性

bonus_value  选填 int

【用户当前积分】用户当前的积分值


service_modules  选填 array[object]

【用户当前服务项】用户当前的会员服务项内容

属性

member_price_word  选填 string(8)

【会员专享价文案】用户会员卡详情页会员优惠栏目中的会员专享价文案


fapiao_jump_word  选填 string(16)

【发票跳转文案】发票栏跳转小程序的引导文案


guide  选填 object

【客服联系信息】设置商家联系人员的名字、头像和联系方式

属性

应答示例

200 OK

1{
2  "card_id": "pbLatjvWOibDc5-TBnbUk1pD12o0",
3  "code": "478515832665",
4  "openid": "obLatjnx9gnqzS4myYGmLZ7LgLBA",
5  "membership_number": "316510891298",
6  "level": "钻石会员",
7  "nickname": "周星星",
8  "head_image_url": "http://wx.qlogo.cn/xxx",
9  "background_picture_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
10  "balance": 888,
11  "user_card_status": "EFFECTIVE",
12  "user_information": {
13    "common_field_list": [
14      {
15        "name": "USER_FORM_FLAG_MOBILE",
16        "value": "深圳"
17    }
18   ],
19    "custom_field_list": [
20  {
21          "name": "喜欢的运动",
22          "value": "篮球",
23          "value_list": [
24            "羽毛球,足球,乒乓球"
25          ]
26        }
27      ]
28      },
29  "bonus_value": 600,
30  "service_modules": [
31    {
32      "service_module_id": "666",
33      "state_setting": {
34        "state_id": "CHECKED_IN",
35        "content_template_data": {
36          "field_list": [
37         {
38            "field_id": "hotel_name",
39            "field_value": "深圳市南山区滨海路700号"
40         }
41      ],
42            "action_setting": {
43              "action_name": "一键开锁",
44              "jump_miniprogram": {
45                "appid": "wx37178d097a6851d8",
46                "path": "pages/index/index"
47              }
48            }
49          },
50        "message_template_setting":[
51       {
52            "message_template_id": "9bJgRNz9XG248XZ-a0nDKH3Vt_vaTp32fRP1LWvxjzI",
53            "field_list": {
54              "field_id": "keyword1",
55              "field_value": "深圳市南山区滨海路700号"
56            }
57           }
58         ]
59        }
60      }
61  ]
62}

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

403

NO_AUTH

商户暂无权限使用此功能

请开通商户号权限。请联系产品或商务申请

500

SYSTEM_ERROR

生成二维码链接失败,请重试

系统异常,请使用相同参数稍后重新调用

400

INVALID_REQUEST

扫码投放场景不支持实时code模式

请更换非实时code模式的会员卡再重试

400

INVALID_REQUEST

会员卡的创建商户号不等于调用方商户号

请使用会员卡的创建商户号进行操作

400

INVALID_REQUEST

请先升级会员卡才能使用此功能

请先调用《升级会员卡API》升级会员卡

400

INVALID_REQUEST

AppID非服务号

请使用正确的服务号的AppID重新调用,不支持App、小程序、订阅号。

400

INVALID_REQUEST

会员卡code分配类型不支持修改

会员卡code分配类型为“系统分配”,不支持修改

400

INVALID_REQUEST

会员卡code分配类型不支持修改为“系统分配”

会员卡code分配类型无法修改为“系统分配”。

400

INVALID_REQUEST

储值小程序path为空

请填写储值小程序path

400

INVALID_REQUEST

会员卡ID无效

请检查会员卡ID是否正确填写

400

INVALID_REQUEST

该会员1年内未在本商家有微信支付交易,无法导入

请更换手机号重试

400

INVALID_REQUEST

会员已经领取过该卡

请使用其他会员卡

400

INVALID_REQUEST

会员卡code为实时模式,需要传入卡code

请填入卡code

400

INVALID_REQUEST

积分跳转path为空

请填写积分跳转path

400

INVALID_REQUEST

自助积分跳转path为空

请填写自助积分跳转path

400

INVALID_REQUEST

会员专享价跳转path为空

请填写会员专享价跳转path

400

INVALID_REQUEST

该手机号和会员卡已被导入过

请更换手机号或会员卡ID重试

400

INVALID_REQUEST

该商户号不是会员卡的创建商户号

请使用会员卡的创建商户号进行操作

400

INVALID_REQUEST

手机号未绑定微信号,无法导入

请更换手机号重试

400

INVALID_REQUEST

商户无授权,请重试

请开通商户号权限。请联系产品或商务申请

400

INVALID_REQUEST

该手机号会员卡记录不存在

请更换手机号或会员卡ID重试

400

INVALID_REQUEST

没有符合条件的数据

请使用正确的参数重新调用

400

INVALID_REQUEST

商户号不属于该卡的创建方

请使用会员卡创建方的商户号重新调用

400

INVALID_REQUEST

会员卡已经迁移

会员卡已经迁移,无需重复操作

400

INVALID_REQUEST

会员权益一旦展示无法关闭

会员权益一旦展示无法关闭

400

INVALID_REQUEST

会员储值一旦展示无法关闭

会员储值一旦展示无法关闭

400

INVALID_REQUEST

需要上架至少一个积分权益、优惠权益、服务才可以投放

请先给会员卡上架至少一个积分权益、优惠权益、服务

400

PARAM ERROR

AppID有误

请使用正确的AppID重新调用

400

PARAM ERROR

OpenID有误

请使用正确的OpenID重新调用

400

PARAM ERROR

商户和品牌关系校验失败

请先将商户号绑定到品牌

400

PARAM ERROR

品牌、AppID关系校验失败

请先将AppID绑定到品牌

 

 

反馈
咨询
目录
置顶