修改会员卡模板信息

更新时间:2025.06.22

更新会员卡的信息,包括基本信息、储值信息、开卡信息等

接口说明

支持商户:【普通服务商】

请求方式:【PATCH】/v3/brand/partner/card-member/cards/{card_id}

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

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

请求参数

Header HTTP头参数

Authorization  必填 string

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


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为application/json


path 路径参数

card_id  必填 string(32)

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


body 包体参数

brand_id  必填 string(32)

【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方


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指引


benefits  选填 string(32)

【会员权益】 会员权益是指平台、品牌或服务机构为付费会员(或等级会员)提供的专属优惠、服务或特权。


notify_url  选填 string(256)

【回调地址】 商家接收开卡成功回调通知的地址,需按照notify_url填写注意事项规范填写。


need_pinned  选填 boolean

【是否置顶】 置顶卡是界面中的一种特殊展示模块,通过人工设置,使其固定在内容列表的顶部位置,确保用户优先看到。默认为false。同一个品牌下允许存在多张置顶卡,按照更新时间倒序排序。


need_display_level  选填 boolean

【是否展示会员等级】 是否在会员卡面向用户展示等级信息,默认不展示(false)


service_phone  选填 string(32)

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


valid_date_information  选填 object

【会员卡有效期】 会员卡有效期

属性

points_information  选填 object

【积分信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。

属性

balance_information  选填 object

【储值信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。

属性

purchase_information  选填 object

【付费会员信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息及会员价格。否则不启动该功能。

属性

user_information  选填 object

【用户开卡信息】 设置用户在开通会员卡时必须填写的信息

属性

请求示例

PATCH

1curl -X PATCH \
2  https://api.mch.weixin.qq.com/v3/brand/partner/card-member/cards/pbLatjvWOibDc5-TBnbUk1pD1 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "brand_id" : "实例值",
8    "card_title" : "测试卡",
9    "card_color" : "#FFFF00",
10    "card_picture_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/0",
11    "benefits" : "会员折扣、专属价",
12    "notify_url" : "https://www.weixin.qq.com/wxpay/notify.php",
13    "need_pinned" : true,
14    "need_display_level" : true,
15    "service_phone" : "010-8877xxxx",
16    "valid_date_information" : {
17      "type" : "PERMANENT",
18      "available_begin_time" : "2020-05-20T13:29:35.120+08:00",
19      "available_end_time" : "2020-05-20T13:29:35.120+08:00",
20      "available_day_after_receive" : 30
21    },
22    "points_information" : {
23      "jump_appid" : "wxea9c30a90fs8d3fe",
24      "jump_path" : "/pages/points/points"
25    },
26    "balance_information" : {
27      "jump_appid" : "wxea9c30a90fs8d3fe",
28      "jump_path" : "/pages/balance/balance"
29    },
30    "purchase_information" : {
31      "price" : 100,
32      "jump_appid" : "wxea9c30a90fs8d3fe",
33      "jump_path" : "/pages/purchase/purchase"
34    },
35    "user_information" : {
36      "common_field_list" : [
37        "USER_FORM_FLAG_SEX"
38      ],
39      "custom_field_list" : [
40        {
41          "type" : "CHECK_BOX",
42          "name" : "喜欢的运动",
43          "values" : [
44            "篮球"
45          ]
46        }
47      ]
48    }
49  }'
50

应答参数

200 OK

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 种类型。

可选取值

  • PURCHASE: 付费

  • NORMAL: 普通

  • BALANCE: 储值​


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 微信支付系统分配,用户领取会员卡时从微信系统分配12位数字作为会员code;(2)MERCHANT_ALLOCATE 商家预存code,商家可提前通过导入预存code接口导入code,用户领取会员卡时平台从商家导入的code中随机分配作为会员code 2、会员卡code分配模式若为“系统分配”,不支持修改为“商家分配”。

可选取值

  • SYSTEM_ALLOCATE: 系统分配

  • MERCHANT_ALLOCATE: 商家分配


code_type  必填 string

【会员码型】 会员码支持不展示码/二维码/条形码/二维码+条形码/跳转商家小程序5种设置。

可选取值

  • NONE_CODE: 不显示任何码型

  • BAR_CODE: 条形码

  • QR_CODE: 二维码

  • BAR_CODE_AND_QR_CODE: 条形码和二维码

  • JUMP_MINI_PROGRAM: 跳转商家小程序


benefits  必填 string(32)

【会员权益】 会员权益是指平台、品牌或服务机构为付费会员(或等级会员)提供的专属优惠、服务或特权。


notify_url  必填 string(256)

【回调地址】 商家接收开卡成功回调通知的地址,需按照notify_url填写注意事项规范填写。


need_pinned  选填 boolean

【是否置顶】 置顶卡是界面中的一种特殊展示模块,通过人工设置,使其固定在内容列表的顶部位置,确保用户优先看到。默认为false。同一个品牌下允许存在多张置顶卡,按照更新时间倒序排序。


need_display_level  选填 boolean

【是否展示会员等级】 是否在会员卡面向用户展示等级信息,默认不展示(false)


init_level  选填 string(10)

【会员初始等级】 展示字段,商家可以自定义填写内容。如果选择了展示会员等级,必填init_level,作为新用户开卡后的初始等级。如因商家业务规则需要变更某会员等级,可通过更新用户会员卡接口更新等级信息。


service_phone  选填 string(32)

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


legal_agreement  选填 string(2048)

【商家法务协议】 商家法务协议是用户与商家之间签订的具有法律效力的合同文件,旨在明确双方在交易、服务提供、权利义务等方面的规则,以保障交易安全、规范商业行为,并在纠纷发生时提供法律依据。


valid_date_information  必填 object

【会员卡有效期】 会员卡有效期

属性

points_information  选填 object

【积分信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。

属性

balance_information  选填 object

【储值信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。

属性

purchase_information  选填 object

【付费会员信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息及会员价格。否则不启动该功能。

属性

user_information  选填 object

【用户开卡信息】 设置用户在开通会员卡时必须填写的信息

属性

state  必填 string

【状态】 会员卡状态信息

可选取值

  • CARD_EFFECTIVE: 生效中

  • CARD_INVALID: 已失效


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

应答示例

200 OK

1{
2  "card_id" : "pbLatjvWOibDc5-TBnbUk1pD12o0",
3  "brand_id" : "1004",
4  "appid" : "wxea9c30890f48d5ae",
5  "card_type" : "NORMAL",
6  "card_title" : "测试卡",
7  "card_color" : "#FFFF00",
8  "card_picture_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/0",
9  "code_mode" : "SYSTEM_ALLOCATE",
10  "code_type" : "BAR_CODE",
11  "benefits" : "会员折扣、专属价",
12  "notify_url" : "https://www.weixin.qq.com/wxpay/notify.php",
13  "need_pinned" : true,
14  "need_display_level" : true,
15  "init_level" : "白银会员",
16  "service_phone" : "010-8877xxxx",
17  "legal_agreement" : "商家需在 48 小时内发货,若商品存在质量问题,用户可在 7 天内申请退货。",
18  "valid_date_information" : {
19    "type" : "PERMANENT",
20    "available_begin_time" : "2020-05-20T13:29:35.120+08:00",
21    "available_end_time" : "2020-05-20T13:29:35.120+08:00",
22    "available_day_after_receive" : 30
23  },
24  "points_information" : {
25    "jump_appid" : "wxea9c30a90fs8d3fe",
26    "jump_path" : "/pages/points/points"
27  },
28  "balance_information" : {
29    "jump_appid" : "wxea9c30a90fs8d3fe",
30    "jump_path" : "/pages/balance/balance"
31  },
32  "purchase_information" : {
33    "price" : 100,
34    "jump_appid" : "wxea9c30a90fs8d3fe",
35    "jump_path" : "/pages/purchase/purchase"
36  },
37  "user_information" : {
38    "common_field_list" : [
39      "USER_FORM_FLAG_SEX"
40    ],
41    "custom_field_list" : [
42      {
43        "type" : "CHECK_BOX",
44        "name" : "喜欢的运动",
45        "values" : [
46          "篮球"
47        ]
48      }
49    ]
50  },
51  "state" : "CARD_EFFECTIVE",
52  "create_time" : "2020-05-20T13:29:35.120+08:00",
53  "update_time" : "2020-05-20T13:29:35.120+08:00"
54}
55

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

 

更多技术问题
技术咨询
反馈
咨询
目录
置顶