200 OK
user_card_code 必填 string(32)
【会员卡code】 会员在一个会员卡模版下的唯一标志,用户领取会员卡后获得的code
card_id 必填 string(32)
【会员卡模板 ID】 商家创建微信会员卡模板成功后系统返回的会员卡模板ID
openid 必填 string(128)
【用户标识】 用户在品牌商家会员卡模板AppID下的唯一标识
card_color 选填 string(7)
【卡背景颜色】 用于卡片正面设计的RGB颜色编码,仅支持十六进制
card_picture_url 选填 string(256)
【卡图片】 商家自定义会员卡背景图。仅支持通过图片上传API接口获取的图片URL地址。支持JPG/JPEG/PNG格式,建议尺寸716px*320px,图片背景色需为透明,且图片小于1M。
brand_id 必填 string(32)
【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方
card_type 必填 string
【会员卡类型】 支持付费、普通、储值 3 种类型。
可选取值
PURCHASE
: 付费
NORMAL
: 普通
BALANCE
: 储值
membership_number 必填 string(32)
【会员卡编号】 在用户会员卡上展示的会员卡编号,默认使用会员卡code作为membership_number
。只能录入数字/英文/半角标点。商家可通过修改用户单张会员卡信息更新
phone_number 必填 string(32)
【加密的手机号】 注册会员的手机号码。解密请参考如何使用API证书解密敏感字段。
level 选填 string(10)
【等级】 用户会员等级,展示字段,商家可以自定义填写内容。
valid_date_information 必填 object
【会员卡有效期】 会员卡有效期
 | 属性 |
| type 必填 string 【有效期类型】 1.该有效期为会员卡激活后的有效期 2.支持绝对有效期&相对有效期设置 3.绝对有效期:固定过期时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE 4.相对有效期:用户激活后x天后有效,x为天数。最多支持10,957天(30年) 5.永久有效 6.过期后卡状态变为“已过期” 7.过期后不再出现服务项,且无法给用户发送会员服务消息通知 可选取值 FIX_TIME_RANGE : 必填available_begin_time和available_end_time,会员卡在此时间[available_begin_time, available_end_time)范围内有效
FIX_TERM : 必填available_day_after_receive,会员卡在用户领取之后available_day_after_receive天内有效
PERMANENT : 会员卡激活后永久有效
available_begin_time 选填 string(32) 【有效期开始时间】 type为FIX_TIME_RANGE时专用, 表示有效期开始时间。需遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2020-05-20T13:29:35.120+08:00表示北京时间2020年05月20日13点29分35秒。
available_end_time 选填 string(32) 【有效期结束时间】 type为FIX_TERM_RANGE时专用,表示有效期结束时间。需遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2020-05-20T13:29:35.120+08:00表示北京时间2020年05月20日13点29分35秒。
available_day_after_receive 选填 integer 【领取后N天内有效】 type为FIX_TERM时专用,表示领取后N个自然天内有效。最长不超过30年 |
pickup_time 必填 string(32)
【领取时间】 用户领取会员卡的时间,需遵循rfc3339标准格式。
user_information 选填 object
【用户开卡时填写的个人信息】 用户开卡时填写的个人信息
 | 属性 |
| common_field_list 选填 array[object] 【平台提供的通用开卡信息字段】 包含性别、手机、头像、昵称、姓名等基本信息字段  | 属性 | | name 选填 string 【平台提供的通用开卡信息字段名称】 平台提供了一些通用的开卡字段供开发者选用。若商户创建会员卡模板时设置该值,则查询结果中会返回给商户。 可选取值 USER_FORM_FLAG_SEX : 用户开卡时需填写性别
USER_FORM_FLAG_NAME : 用户开卡时需填写姓名
USER_FORM_FLAG_BIRTHDAY : 用户开卡时需填写生日
USER_FORM_FLAG_ADDRESS : 用户开卡时需填写地址
USER_FORM_FLAG_EMAIL : 用户开卡时需填写邮箱
USER_FORM_FLAG_CITY : 用户开卡时需填写城市
value 选填 string(128) 【加密的用户开卡时填写的个人信息】 平台提供的通用开卡信息字段,用户在开卡时填写的信息。作为请求字段需加密,作为响应字段需解密。加密使用微信支付公钥加密(推荐),请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引,也可以使用微信支付平台证书公钥加密,参考获取平台证书序列号、平台证书加密敏感信息指引。解密请参考如何使用API证书解密敏感字段。 |
custom_field_list 选填 array[object] 【商家自定义的开卡信息字段】 商家自定义的开卡信息字段,当前最多只允许传入1项 |
attach 选填 string(256)
【商家数据包】 商家在创建用户会员卡时可传入自定义数据包,该数据对用户不可见,用于存储商家自定义信息,其总长度限制在256字符以内。查询用户会员卡详情时会将此字段返回给商家。
user_card_state 必填 string
【用户会员卡状态】 用户当前的卡状态
可选取值
UNACTIVATED
: 用户已领卡,但还未激活
EFFECTIVE
: 用户的会员卡可正常使用
EXPIRED
: 用户的会员卡已过期
INVALID
: 用户的会员卡已失效
invalid_reason 选填 string(32)
【作废原因】 会员卡作废时传入的原因
invalid_time 选填 string(32)
【作废时间】 会员卡作废操作的时间,需遵循rfc3339标准格式。
应答示例
200 OK

1{
2 "user_card_code" : "478515832665",
3 "card_id" : "pbLatjvWOibDc5-TBnbUk1pD12o0",
4 "openid" : "obLatjnx9gnqzS4myYGmLZ7LgLBA",
5 "card_color" : "#FFFF00",
6 "card_picture_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
7 "brand_id" : "1001622624",
8 "card_type" : "NORMAL",
9 "membership_number" : "478515832665",
10 "phone_number" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==",
11 "level" : "钻石会员",
12 "valid_date_information" : {
13 "type" : "PERMANENT",
14 "available_begin_time" : "2020-05-20T13:29:35.120+08:00",
15 "available_end_time" : "2020-05-20T13:29:35.120+08:00",
16 "available_day_after_receive" : 30
17 },
18 "pickup_time" : "2020-05-20T13:29:35.120+08:00",
19 "user_information" : {
20 "common_field_list" : [
21 {
22 "name" : "USER_FORM_FLAG_BIRTHDAY",
23 "value" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="
24 }
25 ],
26 "custom_field_list" : [
27 {
28 "name" : "喜欢的运动",
29 "user_chosen_values" : [
30 "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="
31 ]
32 }
33 ]
34 },
35 "attach" : "自定义数据说明",
36 "user_card_state" : "EFFECTIVE",
37 "invalid_reason" : "传入的自定义作废原因",
38 "invalid_time" : "2020-05-20T13:29:35.120+08:00"
39}
40