查询会员卡模板列表
更新时间:2025.08.01通过此接口可查询指定某品牌的所有会员卡模板列表
接口说明
支持商户:【品牌商户】
请求方式:【GET】/brand/card-member/cards
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
接口限频:100/秒(品牌ID维度)
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
query 查询参数
state 选填 string
【状态】 会员卡状态信息
可选取值
CARD_EFFECTIVE: 生效中CARD_INVALID: 已失效
offset 必填 integer
【分页开始位置】 该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回。
limit 必填 integer
【分页大小,范围为1~20】 分页大小,范围为1~20
请求示例
GET
应答参数
200 OK
data 选填 array[object]
【会员卡模板列表】 符合条件的会员卡模板列表
| 属性 | |||||||||||||||||||||||||||||||||
out_request_no 必填 string(128) 【商家请求单号】 商家创建会员卡模板凭据号。商家自定义,注意保持唯一性,仅供参考的格式:品牌ID+时间戳+流水号。字符仅允许包含英文半角的数字、字母、连接线-和下划线_。 card_id 必填 string(32) 【会员卡模板 ID】 商家创建会员卡模板成功后系统返回的会员卡模板ID brand_id 必填 string(32) 【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方 appid 必填 string 【商家AppID】 商家的AppID,可以是服务号、订阅号、公众号、小程序的AppID。1、该AppID用于获取会员OpenID。2、该AppID需要与会员卡归属品牌有B-A关系。 card_type 必填 string 【会员卡类型】 支持付费、普通、储值 3 种类型。目前仅支持普通会员卡,填写付费和储值类型时会返回错误。 可选取值
card_title 必填 string(10) 【卡名称】 1.可用于展示在卡面的名称 2.支持最长10个中文字 3.支持中文字、英文字符、标点 card_color 必填 string(7) 【卡背景颜色】 用于卡片正面设计的RGB颜色编码,仅支持十六进制 card_picture_url 选填 string(256) 【卡图片】 商家自定义会员卡背景图。仅支持通过图片上传API接口获取的图片URL地址。支持JPG/JPEG/PNG格式,建议尺寸716px*320px,且图片小于1M。查看以下链接后传入:图片要求示例,图片上传API指引。不传时没有默认卡图。 code_mode 必填 string 【会员卡code分配类型】 1、会员卡code是会员在一个会员卡模板下唯一身份标识,平台支持2种分配类型:(1)SYSTEM_ALLOCATE 微信支付系统分配,用户领取会员卡时从微信系统分配24位数字作为会员code;(2)MERCHANT_ALLOCATE 商家分配,商家同步会员开通结果时传入,用户开卡成功或失败都以商家传入的code作为会员卡code。 2、会员卡code分配模式若为“系统分配”,不支持修改为“商家分配”。 可选取值
code_type 必填 string 【会员码展示类型】 会员码支持不展示码/二维码/条形码/二维码+条形码/跳转商家小程序5种设置。 可选取值
code_jump_information 选填 object 【会员码跳转信息】 会员码跳转的小程序信息,当会员码展示类型为跳转商家小程序时必填。
benefits 选填 string(32) 【会员权益】 会员权益是指平台、品牌或服务机构为付费会员(或等级会员)提供的专属优惠、服务或特权。支持用户主动入会时必填。若该值不为空,则会返回该字段。 notify_url 选填 string(256) 【回调地址】 商家接收开卡成功回调通知的地址,需按照notify_url填写注意事项规范填写。支持用户主动入会时必填。若该值不为空,则会返回该字段。 need_pinned 选填 boolean 【是否置顶】 置顶卡是界面中的一种特殊展示模块,通过人工设置,使其固定在内容列表的顶部位置,确保用户优先看到。默认为false。同一个品牌下允许存在多张置顶卡,按照更新时间倒序排序。 need_display_level 选填 boolean 【是否展示会员等级】 是否在会员卡面向用户展示等级信息,默认不展示(false) init_level 选填 string(10) 【会员初始等级】 展示字段,商家可以自定义填写内容。如果选择了展示会员等级,必填 service_phone 选填 string(32) 【服务电话】 展示在会员卡详情内,建议填写商家固定电话 legal_agreement 选填 string(20480) 【商家法务协议】 指用户与商家之间签订的具有法律效力的合同文件,旨在明确双方在交易、服务提供、权利义务等方面的规则,以保障交易安全、规范商业行为,并在纠纷发生时提供法律依据。不支持链接跳转,支持使用 valid_date_information 必填 object 【会员卡有效期】 会员卡有效期
member_information 必填 object 【会员中心信息】 用户点击会员卡卡面的跳转信息
points_information 选填 object 【积分信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。
balance_information 选填 object 【储值信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。
purchase_information 选填 object 【付费会员信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息及会员价格。否则不启动该功能。
user_information 选填 object 【用户开卡信息】 用户开通会员卡时可填写的信息。用户可以选择不填写,不影响开通会员卡;用户填写的内容会在开卡回调中返回给商家。
state 必填 string 【状态】 会员卡状态信息 可选取值
create_time 必填 string 【创建时间】 创建会员卡的时间,需遵循 RFC3339 标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。 modify_time 必填 string 【更新时间】 更新会员卡的时间,需遵循 RFC3339 标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。 support_user_active_join 选填 boolean 【是否支持用户主动入会】 true 表示允许用户在微信支付内主动开通这张会员卡,用户可以通过商家名片、支付相关入会入口,以及商家小程序或 H5 的入会流程填写开卡信息并开通;false 表示用户不能在微信支付内主动开通,只能由商家通过导入等方式开通。 purchase_membership 选填 boolean 【是否为付费会员】 true 表示该会员卡是付费会员,false 表示不是。 |
total_count 必填 integer
【总数量】 总数量
offset 必填 integer
【分页开始位置】 该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回。
limit 必填 integer
【分页大小,范围为1~20】 分页大小,范围为1~20
应答示例
200 OK
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | INVALID_REQUEST | 暂不支持付费或储值的会员卡类型,请修改后重试 | 请创建或使用普通会员卡模板进行操作 |
400 | PARAM_ERROR | 卡名称仅支持中英文字符、数字和标点 | 请修改卡名称,移除不支持的特殊字符 |
400 | PARAM_ERROR | Http header中缺少必填参数Wechatpay-Serial | 缺少必要商品券图片,请补充上传后重试 |
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
429 | RATELIMIT_EXCEEDED | 接口请求频率达到限制 | 请降低请求接口频率 |
400 | PARAM_ERROR | APPID无效或与品牌 ID 没有绑定关系 | 请检查AppID是否有效,并确认其与品牌ID的绑定关系 |
400 | PARAM_ERROR | 固定有效期卡模板必填有效期开始和结束时间 | 请填写具体的有效期开始和结束时间,并移除有效天数信息 |
400 | PARAM_ERROR | 商家请求单号重复 | 请更换商家请求单号,确保其唯一性 |
400 | PARAM_ERROR | 品牌ID与会员码跳转APPID没有绑定关系 | 请检查会员码跳转的AppID是否有效,并确认其与品牌ID的绑定关系 |
400 | PARAM_ERROR | 品牌ID与会员中心跳转APPID没有绑定关系 | 请检查会员中心跳转的AppID是否有效,并确认其与品牌ID的绑定关系 |
400 | PARAM_ERROR | 参数错误 | 请检查请求参数 |
400 | PARAM_ERROR | 会员码型不是“跳转商家小程序”,不允许填写会员码跳转信息 | 请移除会员码跳转信息,或将会员码型设置为跳转商家小程序 |
400 | PARAM_ERROR | 永久有效不允许设置相对有效期 | 当有效期类型为永久时,请移除领取后有效天数字段 |
400 | PARAM_ERROR | 固定时间范围不允许填写领取后有效天数 | 当有效期类型为固定时间时,请移除领取后有效天数字段 |
400 | PARAM_ERROR | 请求内容或图片不符合法规,请重试 | 请检查提交的内容或图片是否合规,修改后重试 |
400 | INVALID_REQUEST | 商家未开通商家名片会员功能 | 请联系运营为该商家开通商家名片会员功能 |
400 | PARAM_ERROR | 非储值会员卡,不允许填写储值小程序信息 | 请移除储值小程序相关信息 |
400 | INVALID_REQUEST | 会员卡模板数量超过限制,每个类型最多创建两个模板 | 请删除多余的会员卡模板,确保每个类型下模板不超过两个 |
400 | PARAM_ERROR | 参数过短 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
400 | PARAM_ERROR | 参数过长 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
400 | PARAM_ERROR | 参数错误 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
400 | PARAM_ERROR | 参数超出取值范围 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
401 | SIGN_ERROR | Http头Authorization值格式错误,请参考《微信支付商户REST API签名规则》 | Http头Authorization值格式错误,请参考《APIv3如何签名和验签》,检查传递的Authorization值是否符合规则 |
400 | INVALID_REQUEST | Http头Content-Type值必须为application/json | 需将Http头中的Content-Type值设置为application/json |
400 | PARAM_ERROR | 传入了不支持的Accept-Language | 传入了不支持的Accept-Language,支持的Accept-Language值请参考应答的语种 |
401 | SIGN_ERROR | Http头Authorization中的timestamp与发起请求的时间不得超过5分钟 | Authorization 头 timestamp 与请求时间间隔超 5 分钟,需重新生成timestamp并替换该字段后重试。 |
401 | SIGN_ERROR | Authorization不合法 | Http头未传递Authorization值或Authorization值格式错误,请参考《APIv3如何签名和验签》,检查传递的Authorization值是否符合规则 |
400 | INVALID_REQUEST | Http头缺少Accept或User-Agent | Http头缺少Accept或User-Agent,请根据API文档在请求头中补充该参数 |
400 | PARAM_ERROR | 请求中含有未在API文档中定义的参数 | 请求中含有未在API文档中定义的参数,请检查传递的参数列表是否有编写错误的字段名 |
401 | SIGN_ERROR | Http头Authorization认证类型不正确 | Http头Authorization认证类型不正确,请将认证类型修改为WECHATPAY-BRAND-SHA256-RSA2048 |
