修改用户会员卡信息

更新时间:2025.06.22

通过此接口可更新指定用户的会员卡背景图、会员卡号、等级等信息

接口说明

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

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

请求域名:【主域名】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


 Wechatpay-Serial  必填 string

【微信支付公钥ID】或【微信支付平台证书序列号】  请求参数中的敏感字段,需要使用微信支付公钥加密(推荐),请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引;也可以使用微信支付平台证书公钥加密,参考获取平台证书序列号平台证书加密敏感信息指引


path  路径参数

 user_card_code  必填   string(32)

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


query  查询参数

 card_id  必填   string(32)

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


body  包体参数

 brand_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。图片上传API指引


 phone_number  选填   string(512)

【加密的手机号】 注册会员的手机号码。该字段需要使用微信支付公钥加密(推荐),请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引,也可以使用微信支付平台证书公钥加密,参考获取平台证书序列号平台证书加密敏感信息指引


 level  选填   string(10)

【等级】 用户会员等级,展示字段,商家可以自定义填写内容。


 valid_date_information  选填   object

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

属性

 user_information  选填   object

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

属性

 attach  选填   string(256)

【商家数据包】 商家在创建用户会员卡时可传入自定义数据包,该数据对用户不可见,用于存储商家自定义信息,其总长度限制在256字符以内。查询用户会员卡详情时会将此字段返回给商家。

请求示例

Java
Go
curl

需配合微信支付工具库 WXPayUtility 使用,请参考 Java 

1package com.java.demo;
2
3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777
4
5import com.google.gson.annotations.SerializedName;
6import com.google.gson.annotations.Expose;
7import okhttp3.MediaType;
8import okhttp3.OkHttpClient;
9import okhttp3.Request;
10import okhttp3.RequestBody;
11import okhttp3.Response;
12
13import java.io.IOException;
14import java.io.UncheckedIOException;
15import java.security.PrivateKey;
16import java.security.PublicKey;
17import java.util.ArrayList;
18import java.util.HashMap;
19import java.util.List;
20import java.util.Map;
21
22/**
23 * 修改用户会员卡信息
24 */
25public class UpdateUserCard {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "PATCH";
28  private static String PATH = "/v3/brand/partner/card-member/user-cards/{user_card_code}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    UpdateUserCard client = new UpdateUserCard(
33      "19xxxxxxxx",                    // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
34      "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
35      "/path/to/apiclient_key.pem",    // 商户API证书私钥文件路径,本地文件路径
36      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
37      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径,本地文件路径
38    );
39
40    UpdateUserCardRequest request = new UpdateUserCardRequest();
41    request.userCardCode = "478515832665";
42    request.cardId = "pbLatjvWOibDc5-TBnbUk1pD12o0";
43    request.brandId = "1004";
44    request.openid = "obLatjnx9gnqzS4myYGmLZ7LgLBA";
45    request.cardColor = "#FFFF00";
46    request.cardPictureUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0";
47    request.phoneNumber = client.encrypt("phone_number");
48    request.level = "钻石会员";
49    request.validDateInformation = new DateInfo();
50    request.validDateInformation.type = DateType.PERMANENT;
51    request.validDateInformation.availableBeginTime = "2020-05-20T13:29:35.120+08:00";
52    request.validDateInformation.availableEndTime = "2020-05-20T13:29:35.120+08:00";
53    request.validDateInformation.availableDayAfterReceive = 30L;
54    request.userInformation = new UserInfo();
55    request.userInformation.commonFieldList = new ArrayList<>();
56    {
57      UserInfoCommonField commonFieldListItem = new UserInfoCommonField();
58      commonFieldListItem.name = CommonFieldFlag.USER_FORM_FLAG_BIRTHDAY;
59      commonFieldListItem.value = client.encrypt("value");
60      request.userInformation.commonFieldList.add(commonFieldListItem);
61    };
62    request.userInformation.customFieldList = new ArrayList<>();
63    {
64      UserInfoCustomField customFieldListItem = new UserInfoCustomField();
65      customFieldListItem.name = "喜欢的运动";
66      customFieldListItem.userChosenValues = new ArrayList<>();
67      {
68        customFieldListItem.userChosenValues.add("vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==");
69      };
70      request.userInformation.customFieldList.add(customFieldListItem);
71    };
72    request.attach = "自定义数据说明";
73    try {
74      UserCard response = client.run(request);
75
76      // TODO: 请求成功,继续业务逻辑
77      System.out.println(response);
78    } catch (WXPayUtility.ApiException e) {
79      // TODO: 请求失败,根据状态码执行不同的逻辑
80      e.printStackTrace();
81    }
82  }
83
84  public UserCard run(UpdateUserCardRequest request) {
85    String uri = PATH;
86    uri = uri.replace("{user_card_code}", WXPayUtility.urlEncode(request.userCardCode));
87    Map<String, Object> args = new HashMap<>();
88    args.put("card_id", request.cardId);
89    uri = uri + "?" + WXPayUtility.urlEncode(args);
90    String reqBody = WXPayUtility.toJson(request);
91
92    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
93    reqBuilder.addHeader("Accept", "application/json");
94    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
95    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
96    reqBuilder.addHeader("Content-Type", "application/json");
97    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
98    reqBuilder.method(METHOD, requestBody);
99    Request httpRequest = reqBuilder.build();
100
101    // 发送HTTP请求
102    OkHttpClient client = new OkHttpClient.Builder().build();
103    try (Response httpResponse = client.newCall(httpRequest).execute()) {
104      String respBody = WXPayUtility.extractBody(httpResponse);
105      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
106        // 2XX 成功,验证应答签名
107        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
108            httpResponse.headers(), respBody);
109
110        // 从HTTP应答报文构建返回数据
111        return WXPayUtility.fromJson(respBody, UserCard.class);
112      } else {
113        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
114      }
115    } catch (IOException e) {
116      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
117    }
118  }
119
120  private final String mchid;
121  private final String certificateSerialNo;
122  private final PrivateKey privateKey;
123  private final String wechatPayPublicKeyId;
124  private final PublicKey wechatPayPublicKey;
125
126  public UpdateUserCard(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
127    this.mchid = mchid;
128    this.certificateSerialNo = certificateSerialNo;
129    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
130    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
131    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
132  }
133
134  public String encrypt(String plainText) {
135    return WXPayUtility.encrypt(this.wechatPayPublicKey, plainText);
136  }
137
138  public static class UpdateUserCardRequest {
139    @SerializedName("brand_id")
140    public String brandId;
141  
142    @SerializedName("user_card_code")
143    @Expose(serialize = false)
144    public String userCardCode;
145  
146    @SerializedName("card_id")
147    @Expose(serialize = false)
148    public String cardId;
149  
150    @SerializedName("openid")
151    public String openid;
152  
153    @SerializedName("card_color")
154    public String cardColor;
155  
156    @SerializedName("card_picture_url")
157    public String cardPictureUrl;
158  
159    @SerializedName("phone_number")
160    public String phoneNumber;
161  
162    @SerializedName("level")
163    public String level;
164  
165    @SerializedName("valid_date_information")
166    public DateInfo validDateInformation;
167  
168    @SerializedName("user_information")
169    public UserInfo userInformation;
170  
171    @SerializedName("attach")
172    public String attach;
173  }
174  
175  public static class UserCard {
176    @SerializedName("user_card_code")
177    public String userCardCode;
178  
179    @SerializedName("card_id")
180    public String cardId;
181  
182    @SerializedName("openid")
183    public String openid;
184  
185    @SerializedName("card_color")
186    public String cardColor;
187  
188    @SerializedName("card_picture_url")
189    public String cardPictureUrl;
190  
191    @SerializedName("brand_id")
192    public String brandId;
193  
194    @SerializedName("card_type")
195    public CardType cardType;
196  
197    @SerializedName("phone_number")
198    public String phoneNumber;
199  
200    @SerializedName("level")
201    public String level;
202  
203    @SerializedName("valid_date_information")
204    public DateInfo validDateInformation;
205  
206    @SerializedName("pickup_time")
207    public String pickupTime;
208  
209    @SerializedName("user_information")
210    public UserInfo userInformation;
211  
212    @SerializedName("attach")
213    public String attach;
214  
215    @SerializedName("user_card_state")
216    public UserCardState userCardState;
217  
218    @SerializedName("invalid_reason")
219    public String invalidReason;
220  
221    @SerializedName("invalid_time")
222    public String invalidTime;
223  
224    @SerializedName("create_time")
225    public String createTime;
226  
227    @SerializedName("modify_time")
228    public String modifyTime;
229  }
230  
231  public static class DateInfo {
232    @SerializedName("type")
233    public DateType type;
234  
235    @SerializedName("available_begin_time")
236    public String availableBeginTime;
237  
238    @SerializedName("available_end_time")
239    public String availableEndTime;
240  
241    @SerializedName("available_day_after_receive")
242    public Long availableDayAfterReceive;
243  }
244  
245  public static class UserInfo {
246    @SerializedName("common_field_list")
247    public List<UserInfoCommonField> commonFieldList;
248  
249    @SerializedName("custom_field_list")
250    public List<UserInfoCustomField> customFieldList;
251  }
252  
253  public enum CardType {
254    @SerializedName("PURCHASE")
255    PURCHASE,
256    @SerializedName("NORMAL")
257    NORMAL,
258    @SerializedName("BALANCE")
259    BALANCE
260  }
261  
262  public enum UserCardState {
263    @SerializedName("UNACTIVATED")
264    UNACTIVATED,
265    @SerializedName("EFFECTIVE")
266    EFFECTIVE,
267    @SerializedName("EXPIRED")
268    EXPIRED,
269    @SerializedName("INVALID")
270    INVALID
271  }
272  
273  public enum DateType {
274    @SerializedName("FIX_TIME_RANGE")
275    FIX_TIME_RANGE,
276    @SerializedName("FIX_TERM")
277    FIX_TERM,
278    @SerializedName("PERMANENT")
279    PERMANENT
280  }
281  
282  public static class UserInfoCommonField {
283    @SerializedName("name")
284    public CommonFieldFlag name;
285  
286    @SerializedName("value")
287    public String value;
288  }
289  
290  public static class UserInfoCustomField {
291    @SerializedName("name")
292    public String name;
293  
294    @SerializedName("user_chosen_values")
295    public List<String> userChosenValues;
296  }
297  
298  public enum CommonFieldFlag {
299    @SerializedName("USER_FORM_FLAG_SEX")
300    USER_FORM_FLAG_SEX,
301    @SerializedName("USER_FORM_FLAG_NAME")
302    USER_FORM_FLAG_NAME,
303    @SerializedName("USER_FORM_FLAG_BIRTHDAY")
304    USER_FORM_FLAG_BIRTHDAY,
305    @SerializedName("USER_FORM_FLAG_ADDRESS")
306    USER_FORM_FLAG_ADDRESS,
307    @SerializedName("USER_FORM_FLAG_EMAIL")
308    USER_FORM_FLAG_EMAIL,
309    @SerializedName("USER_FORM_FLAG_CITY")
310    USER_FORM_FLAG_CITY
311  }
312  
313}
314

应答参数

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:  储值​


 phone_number  选填   string(512)

【加密的手机号】 注册会员的手机号码,仅在用户授权手机号、商家通过 API 传入的情况下有值。解密请参考如何使用API证书解密敏感字段


 level  选填   string(10)

【等级】 用户会员等级,展示字段,商家可以自定义填写内容。


 valid_date_information  必填   object

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

属性

 pickup_time  必填   string(32)

【领取时间】 用户领取会员卡的时间,需遵循 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秒。


 user_information  选填   object

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

属性

 attach  选填   string(256)

【商家数据包】 商家在创建用户会员卡时可传入自定义数据包,该数据对用户不可见,用于存储商家自定义信息,其总长度限制在256字符以内。查询用户会员卡详情时会将此字段返回给商家。


 user_card_state  必填   string

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

可选取值

  • UNACTIVATED:  用户已领卡,但还未激活

  • EFFECTIVE:  用户的会员卡可正常使用

  • EXPIRED:  用户的会员卡已过期

  • INVALID:  用户的会员卡已失效


 invalid_reason  选填   string(32)

【作废原因】 会员卡作废时传入的原因


 invalid_time  选填   string(32)

【作废时间】 会员卡作废操作的时间,需遵循 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秒。


 create_time  必填   string(32)

【创建时间】 创建会员卡的时间,需遵循 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(32)

【更新时间】 更新会员卡的时间,需遵循 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秒。

应答示例

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  "phone_number" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==",
10  "level" : "钻石会员",
11  "valid_date_information" : {
12    "type" : "PERMANENT",
13    "available_begin_time" : "2020-05-20T13:29:35.120+08:00",
14    "available_end_time" : "2020-05-20T13:29:35.120+08:00",
15    "available_day_after_receive" : 30
16  },
17  "pickup_time" : "2020-05-20T13:29:35.120+08:00",
18  "user_information" : {
19    "common_field_list" : [
20      {
21        "name" : "USER_FORM_FLAG_BIRTHDAY",
22        "value" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="
23      }
24    ],
25    "custom_field_list" : [
26      {
27        "name" : "喜欢的运动",
28        "user_chosen_values" : [
29          "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="
30        ]
31      }
32    ]
33  },
34  "attach" : "自定义数据说明",
35  "user_card_state" : "EFFECTIVE",
36  "invalid_reason" : "传入的自定义作废原因",
37  "invalid_time" : "2020-05-20T13:29:35.120+08:00",
38  "create_time" : "2020-05-20T13:29:35.120+08:00",
39  "modify_time" : "2020-05-20T13:29:35.120+08:00"
40}
41

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

INVALID_REQUEST

会员卡模版ID不属于该品牌

请确认品牌ID和会员卡模版ID是否正确

 

反馈
咨询
目录
置顶