创建会员卡模板

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

Content-Type 　必填　string

请设置为application/json

body 包体参数

appid 　必填 string(32)

【商户AppID】 商户的公众号AppID。
1、只能为服务号AppID，不支持App、小程序、订阅号的AppID。
2、该AppID用于获取会员OpenID及unionid。
3、会员相关（会员状态、权益、服务）消息将通过该服务号触达用户
4、该AppID需要与会员卡归属品牌有B-A关系

logo_url 　必填 string(128)

【会员卡logo】 会员卡logo的URL地址。仅支持通过《图片上传API》接口获取的图片URL地址。
1、商户logo大小需为120像素*120像素。
2、支持JPG/JPEG/PNG格式，且图片小于1M。

brand 　必填 object

【品牌信息】 该会员卡归属的品牌信息

	属性
	brand_id 　必填 string(16) 【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID（灰度期间联系微信支付运营获取），用于标记该会员卡的归属方 display_name 　必填 string(10) 【品牌展示名称】 1.展示在会员卡面上 2.支持最长10个中文字 3.支持中文字、英文字符

title 　必填 string(10)

【卡名称】 1.展示在卡面上

2.支持最长10个中文字

3.支持中文字、英文字符、标点

background_picture_url 　必填 string(128)

【会员卡背景图】 商家自定义会员卡背景图。仅支持通过《图片上传API》接口获取的图片URL地址。
1、大小需为1000像素*600像素。
2、支持JPG/JPEG/PNG格式，且图片小于1M。

description 　必填 string(500)

【使用须知】 展示在会员卡详情内，最长500个中文字符，建议填写会员权益及服务相关描述。

service_phone 　选填 string(32)

【服务电话】 展示在会员卡详情内，建议填写商家固定电话

code_type 　必填 string

【会员码型】 员卡的码型支持二维码/条形码/二维码+条形码/不展示码，这4种码型是根据membershipnumber字段生成，用户领卡后membershipnumber默认为code值，支持商户修改

total_quantity 　选填 integer

【会员卡总库存】 可投放的最大会员卡数量。仅在会员卡code分配类型为系统自动分配（SYSTEM_ALLOCATE）时需要填写，其他分配类型不需要填写库存。系统分配code类型下，若未填写总库存，则微信支付系统会默认将总库存设置为5000000 （默认值）。

date_information 　必填 object

【有效期】 有效期

属性

type 　必填 string 【有效期类型】 1.该有效期为会员卡激活后的有效期 2.支持绝对有效期&相对有效期设置 3.绝对有效期：固定过期时间，格式为yyyy-mm-dd hh-mm-ss 4.相对有效期：用户激活后x天后有效，x为天数。最多支持10,957天（30年） 5.永久有效 6.过期后卡状态变为“已过期”，出现在卡包历史卡券。 7.过期后不再出现服务项，且会员服务触达无法再次下发 枚举值： FIX_TIME_RANGE：固定时间范围内有效 FIX_TERM：相对时间范围内有效 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_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_day_after_receive 　选填 int 【生效后N天内有效】 type为FIX_TERM时专用，表示生效后N天内有效，领取后当天有效填写0（单位为天）。最长不超过30年 wait_days_after_receive 　选填 int 【领取后N天开始生效】 type为FIX_TERM时专用，表示自领取后N天开始生效。（单位为天）

code_mode 　必填 string

【会员卡code分配类型】1、会员卡code是会员在card_id下唯一身份标识，平台支持3中分配类型：
SYSTEM_ALLOCATE 微信支付系统分配，用户领取会员卡时从微信支付系统分配12位数字作为会员code；
MERCHANT_DEPOSIT 商户预存code，商户可提前通过导入预存code接口导入code，用户领取会员卡时平台从商户导入的code中随机分配作为会员code
REAL_TIME 商家在激活时实时传入code，该模式仅支持小程序拉起开卡组件投放，不支持通过支付后、二维码投放。
2、会员卡code分配模式一旦指定，不支持修改。
SYSTEM_ALLOCATE：系统分配
MERCHANT_DEPOSIT：商户预存
REAL_TIME：实时传入

need_display_level 　选填 boolean

【是否展示会员等级】 是否在会员卡面向用户展示等级信息，默认不展示（false）

init_level 　选填 string(5)

【会员初始等级】 如果展示会员等级，必填init_level，作为新用户开卡后的初始等级。如因商家业务规则需要变更某会员等级，可通过更新用户会员卡接口更新等级信息

out_request_no 　必填 string(128)

【商户请求单号】 商户创建会员卡凭据号。商户自定义，注意保持唯一性，仅供参考的格式：商户ID+日期+流水号。可包含英文字母，数字，｜，_，*，-等内容，不允许出现其他不合法符号。

balance_information 　选填 object

【储值信息】 储值信息

	属性
	need_balance 　选填 boolean 【是否支持储值】 储值额在会员卡面上展示，展示该字段的商户需要有单用途商业预付卡资质。如不填写，默认不展示储值余额 balance_appid 　选填 string(32) 【储值小程序AppID】 点击储值额跳转的小程序AppID。只有支持储值，此字段才有效 balance_path 　选填 string(128) 【储值小程序path】 点击储值额跳转的小程序页面path，建议为储值充值页面。只有支持储值，此字段才有效 若填写了储值小程序AppID，储值小程序path为必填项 balance_url 　选填 string(128) 【储值URL】 点击储值额跳转的h5页面。只有支持储值，此字段才有效

user_information_form 　选填 object

【开卡信息】 用户在开通会员卡时需要填写的信息

属性

common_field_list 　选填 array[256] 【平台提供的通用开卡信息字段】平台提供了一些通用的开卡字段供开发者选用 枚举值： USER_FORM_FLAG_MOBILE：手机号 USER_FORM_FLAG_SEX：性别 USER_FORM_FLAG_NAME：姓名 USER_FORM_FLAG_BIRTHDAY：生日 USER_FORM_FLAG_ADDRESS：地址 USER_FORM_FLAG_EMAIL：邮箱 USER_FORM_FLAG_CITY：城市 custom_field_list 　选填 array[object] 【商户自定义的开卡信息字段】 商户自定义的开卡信息字段 属性 type 　选填 string 【字段类型】 选择所需的字段类型： TEXT：文本型 SELECT：自定义选择项 RADIO：自定义单选 CHECK_BOX：自定义多选 name 　选填 string(5) 【字段名称】 信息项的名称 values 　选填 array[string(8)] 【字段值】 信息项的值列表 特殊规则：列表最多支持10个，单个列表限制8个字符

additional_statement 　选填 object

【商户补充声明】 商户补充声明

	属性
	title 　选填 string(20) 【标题】 商户补充声明的标题，如果填写，将会在用户开卡时展示给用户，用户可点击跳转到商户指定的链接或者小程序，了解声明的详情 url 　选填 string(128) 【跳转URL】 用户在开卡页面点击查看“商户补充声明”，会跳转到URL指定的页面。如果同时配置了URL和AppID/path，则优先跳转到小程序 appid 　选填 string(32) 【跳转小程序AppID】 用户在开卡页面点击查看“商户补充声明”，会跳转到小程序指定页面。如果同时配置了URL和appid/path，则优先跳转到小程序 path 　选填 string(128) 【跳转小程序path】 用户在开卡页面点击查看“商户补充声明”，会跳转到小程序指定页面。如果同时配置了URL和appid/path，则优先跳转到小程序

need_dynamic_code 　选填 boolean

【是否启用动态码】 是否启用动态码功能。若启用，用户会员卡的身份识别码会被系统生成的18位数字取替，动态改变，可有效保障用户的储值资产安全，降低用户因被截图带来的储值盗用风险。默认为false

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/marketing/membercard-open/cards \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7  "appid": "wxea9c30890f48d5ae",
8  "logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
9  "brand": {
10    "brand_id": "1004",
11    "display_name": "微信支付"
12  },
13  "title": "微信支付测试卡",
14  "background_picture_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
15  "description": "使用本会员卡表示你同意xxx公司的协议",
16  "service_phone": "010-8877xxxx",
17  "code_type": "BAR_CODE",
18  "total_quantity": 5000000,
19  "date_information": {
20    "type": "FIX_TIME_RANGE",
21    "available_begin_time": "2020-05-20T13:29:35.120+08:00",
22    "available_end_time": "2030-05-20T13:29:35.120+08:00",
23    "available_day_after_receive": 200,
24    "wait_days_after_receive": 1
25  },
26  "code_mode": "SYSTEM_ALLOCATE",
27  "need_display_level": true,
28  "init_level": "白银会员",
29  "out_request_no": "100002322019090134234sfdf",
30  "balance_information": {
31    "need_balance": false,
32    "balance_appid": "wxea9c30890f48d5ae",
33    "balance_path": "pages/balance/balance",
34    "balance_url": "https://xxx.com"
35  },
36  "user_information_form": {
37    "common_field_list": [
38        "USER_FORM_FLAG_MOBILE",
39        "USER_FORM_FLAG_SEX",
40        "USER_FORM_FLAG_NAME",
41        "USER_FORM_FLAG_BIRTHDAY"
42      ],
43    "custom_field_list": [
44      {
45        "type": "TEXT",
46        "name": "喜欢的运动",
47        "values": [
48          "篮球",
49          "足球",
50          "羽毛球"
51        ]
52      }
53    ]
54  },
55  "additional_statement": {
56    "title": "xxx会员卡使用须知",
57    "url": "https://xxx.111.com",
58    "appid": "wxea9c30890f48d5ae",
59    "path": "pages/statement/statement"
60  },
61  "need_dynamic_code": false
62}'
63

card_id 　必填 string(32)

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

create_time 　选填 string(32)

【创建时间】 创建会员卡模板的时间

遵循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秒。

update_time 　选填 string(32)

【更新时间】 商户最近一次更新会员卡模板的时间

遵循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秒。

remain_quantity 　选填 integer

【剩余库存】 会员卡剩余的库存

status 　选填 string

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

会员卡当前的状态：
NOT_APPROVE：待审核
APPROVE_FAIL：审核失败
APPROVED：通过审核
DELETED：卡被商户删除

brand 　必填 object

【品牌信息】 该会员卡归属的品牌信息

	属性
	brand_id 　必填 string(16) 【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID（灰度期间联系微信支付运营获取），用于标记该会员卡的归属方 display_name 　必填 string(10) 【品牌展示名称】 1.展示在会员卡面上 2.支持最长10个中文字 3.支持中文字、英文字符

appid 　必填 string(32)

【品牌AppID】 1.展示在卡面上
2.支持最长10个中文字
3.支持中文字、英文字符、标点

logo_url 　必填 string(128)

【会员卡logo】 会员卡logo的URL地址。仅支持通过《图片上传API》接口获取的图片URL地址。
1、商户logo大小需为120像素*120像素。
2、支持JPG/JPEG/PNG格式，且图片小于1M。

title 　必填 string(10)

【卡名称】 1.展示在卡面上

2.支持最长10个中文字

3.支持中文字、英文字符、标点

background_picture_url 　必填 string(128)

【会员卡背景图】 商家自定义会员卡背景图。仅支持通过《图片上传API》接口获取的图片URL地址。
1、大小需为1000像素*600像素。
2、支持JPG/JPEG/PNG格式，且图片小于1M。

description 　必填 string(500)

【使用须知】 展示在会员卡详情内，最长500个中文字符，建议填写会员权益及服务相关描述。

service_phone 　选填 string(32)

【服务电话】 展示在会员卡详情内，建议填写商家固定电话

code_type 　必填 string

【会员码型】 员卡的码型支持二维码/条形码/二维码+条形码/不展示码，这4种码型是根据membershipnumber字段生成，用户领卡后membershipnumber默认为code值，支持商户修改
枚举值：
BAR_CODE：条形码
QRCODE：二维码
BAR_CODE_AND_QRCODE：条形码和二维码
NONE_CODE：不显示任何码型

total_quantity 　选填 integer

【会员卡总库存】 可投放的最大会员卡数量。仅在会员卡code分配类型为系统自动分配（SYSTEM_ALLOCATE）时需要填写，其他分配类型不需要填写库存。系统分配code类型下，若未填写总库存，则微信支付系统会默认将总库存设置为5000000 （默认值）。

date_information 　必填 object

【有效期】 有效期

属性

type 　必填 string 【有效期类型】 1.该有效期为会员卡激活后的有效期 2.支持绝对有效期&相对有效期设置 3.绝对有效期：固定过期时间，格式为yyyy-mm-dd hh-mm-ss 4.相对有效期：用户激活后x天后有效，x为天数。最多支持10,957天（30年） 5.永久有效 6.过期后卡状态变为“已过期”，出现在卡包历史卡券。 7.过期后不再出现服务项，且会员服务触达无法再次下发 枚举值： FIX_TIME_RANGE：固定时间范围内有效 FIX_TERM：相对时间范围内有效 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天内有效，领取后当天有效填写0（单位为天）。最长不超过30年 wait_days_after_receive 　选填 integer 【领取后N天开始生效】 type为FIX_TERM时专用，表示自领取后N天开始生效。（单位为天）

code_mode 　必填 string

【会员卡code分配类型】1、会员卡code是会员在card_id下唯一身份标识，平台支持3中分配类型：
SYSTEM_ALLOCATE 微信支付系统分配，用户领取会员卡时从微信支付系统分配12位数字作为会员code；
MERCHANT_DEPOSIT 商户预存code，商户可提前通过导入预存code接口导入code，用户领取会员卡时平台从商户导入的code中随机分配作为会员code
REAL_TIME 商家在激活时实时传入code，该模式仅支持小程序拉起开卡组件投放，不支持通过支付后、二维码投放。
2、会员卡code分配模式一旦指定，不支持修改。
SYSTEM_ALLOCATE：系统分配
MERCHANT_DEPOSIT：商户预存
REAL_TIME：实时传入

need_display_level 　选填 boolean

【是否展示会员等级】 是否在会员卡面向用户展示等级信息，默认不展示（false）

init_level 　选填 string(5)

【会员初始等级】 如果展示会员等级，必填init_level，作为新用户开卡后的初始等级。如因商家业务规则需要变更某会员等级，可通过更新用户会员卡接口更新等级信息

out_request_no 　必填 string(128)

【商户请求单号】 商户创建会员卡凭据号。商户自定义，注意保持唯一性，仅供参考的格式：商户ID+日期+流水号。可包含英文字母，数字，｜，_，*，-等内容，不允许出现其他不合法符号。

balance_information 　选填 object

【储值信息】 储值信息

	属性
	need_balance 　选填 boolean 【是否支持储值】 储值额在会员卡面上展示，展示该字段的商户需要有单用途商业预付卡资质。如不填写，默认不展示储值余额 balance_appid 　选填 string(32) 【储值小程序AppID】 点击储值额跳转的小程序AppID。只有支持储值，此字段才有效 balance_path 　选填 string(128) 【储值小程序path】 点击储值额跳转的小程序页面path，建议为储值充值页面。只有支持储值，此字段才有效 若填写了储值小程序AppID，储值小程序path为必填项 balance_url 　选填 string(128) 【储值URL】 点击储值额跳转的h5页面。只有支持储值，此字段才有效

user_information_form 　选填 object

【开卡信息】 用户在开通会员卡时需要填写的信息

属性

common_field_list 　选填 array[string] 【平台提供的通用开卡信息字段】平台提供了一些通用的开卡字段供开发者选用 枚举值： USER_FORM_FLAG_MOBILE：手机号 USER_FORM_FLAG_SEX：性别 USER_FORM_FLAG_NAME：姓名 USER_FORM_FLAG_BIRTHDAY：生日 USER_FORM_FLAG_ADDRESS：地址 USER_FORM_FLAG_EMAIL：邮箱 USER_FORM_FLAG_CITY：城市 custom_field_list 　选填 array[object] 【商户自定义的开卡信息字段】 商户自定义的开卡信息字段 数组 type 　选填 string 【字段类型】 选择所需的字段类型 TEXT：文本型 SELECT：自定义选择项 RADIO：自定义单选 CHECK_BOX：自定义多选 name 　选填 string(5) 【字段名称】 信息项的名称 values 　选填 array[string(8)] 【字段值】 信息项的值列表 特殊规则：列表最多支持10个，单个列表限制8个字符

additional_statement 　选填 object

【商户补充声明】 商户补充声明

	属性
	title 　选填 string(20) 【标题】 商户补充声明的标题，如果填写，将会在用户开卡时展示给用户，用户可点击跳转到商户指定的链接或者小程序，了解声明的详情 url 　选填 string(128) 【跳转URL】 用户在开卡页面点击查看“商户补充声明”，会跳转到URL指定的页面。如果同时配置了URL和AppID/path，则优先跳转到小程序 appid 　选填 string(32) 【跳转小程序AppID】 用户在开卡页面点击查看“商户补充声明”，会跳转到小程序指定页面。如果同时配置了URL和appid/path，则优先跳转到小程序 path 　选填 string(128) 【跳转小程序path】 用户在开卡页面点击查看“商户补充声明”，会跳转到小程序指定页面。如果同时配置了URL和appid/path，则优先跳转到小程序

need_dynamic_code 　选填 boolean

【是否启用动态码】 是否启用动态码功能。若启用，用户会员卡的身份识别码会被系统生成的18位数字取替，动态改变，可有效保障用户的储值资产安全，降低用户因被截图带来的储值盗用风险。默认为false

应答示例

200 OK

1{
2  "card_id": "pbLatjvWOibDc5-TBnbUk1pD12o0",
3  "create_time": "2020-05-20T13:29:35.120+08:00",
4  "update_time": "2020-05-20T13:29:35.120+08:00",
5  "remain_quantity": 1004,
6  "status": "NOT_APPROVE",
7  "brand": {
8    "brand_id": "1004",
9    "display_name": "微信支付"
10  },
11  "appid": "wxea9c30890f48d5ae",
12  "logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
13  "title": "微信支付测试卡",
14  "background_picture_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
15  "description": "使用本会员卡表示你同意xxx公司的协议",
16  "service_phone": "010-8877xxxx",
17  "code_type": "BAR_CODE",
18  "total_quantity": 5000000,
19  "date_information": {
20    "type": "FIX_TIME_RANGE",
21    "available_begin_time": "2020-05-20T13:29:35.120+08:00",
22    "available_end_time": "2030-05-20T13:29:35.120+08:00",
23    "available_day_after_receive": 200,
24    "wait_days_after_receive": 1
25  },
26  "code_mode": "SYSTEM_ALLOCATE",
27  "need_display_level": true,
28  "init_level": "白银会员",
29  "out_request_no": "100002322019090134234sfdf",
30  "balance_information": {
31    "need_balance": false,
32    "balance_appid": "wxea9c30890f48d5ae",
33    "balance_path": "pages/balance/balance",
34    "balance_url": "https://xxx.com"
35  },
36  "user_information_form": {
37    "common_field_list": [
38        "USER_FORM_FLAG_MOBILE",
39        "USER_FORM_FLAG_SEX",
40        "USER_FORM_FLAG_NAME",
41        "USER_FORM_FLAG_BIRTHDAY"
42      ],
43    "custom_field_list": [
44      {
45        "type": "TEXT",
46        "name": "喜欢的运动",
47        "values": [
48          "篮球",
49          "足球",
50          "羽毛球"
51        ]
52      }
53    ]
54  },
55  "additional_statement": {
56    "title": "xxx会员卡使用须知",
57    "url": "https://xxx.111.com",
58    "appid": "wxea9c30890f48d5ae",
59    "path": "pages/statement/statement"
60  },
61  "need_dynamic_code": false
62}
63