修改用户会员卡信息
更新时间:2025.07.25通过此接口可更新指定用户的会员卡背景图、会员卡号、等级等信息
接口限频:按品牌商户品牌 ID 维度 5 次/秒
接口说明
支持商户:【品牌商户】
请求方式:【PATCH】/brand/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】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
path 路径参数
user_card_code 必填 string(32)
【会员卡code】 会员在一个会员卡模板下的唯一标识,用户领取会员卡后获得的code。只能填写数字/英文/半角标点。
body 包体参数
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。请查看以下链接后传入:图片要求示例,图片上传API指引
phone_number 选填 string(512)
【加密的手机号】 注册会员的手机号码。该字段需要使用微信支付公钥加密,请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引。
level 选填 string(10)
【等级】 用户会员等级,展示字段,商家可以自定义填写内容。
valid_date_information 选填 object
【会员卡有效期】 会员卡有效期
| 属性 | |
type 选填 string 【有效期类型】 1.该有效期为会员卡激活后的有效期 2.支持绝对有效期&相对有效期设置 3.绝对有效期:固定过期时间,需遵循 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秒。 4.相对有效期:用户激活后x天后有效,x为天数。最多支持10,957天(30年) 5.永久有效 6.过期后卡状态变为“已过期” 7.过期后不再出现服务项,且无法给用户发送会员服务消息通知 可选取值
available_begin_time 选填 string(32) 【有效期开始时间】 type为FIX_TIME_RANGE时专用, 表示有效期开始时间。需需遵循 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秒。 available_end_time 选填 string(32) 【有效期结束时间】 type为FIX_TERM_RANGE时专用,表示有效期结束时间。需需遵循 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秒。 available_day_after_receive 选填 integer 【领取后N天内有效】 type为FIX_TERM时专用,表示领取后N个自然天内有效。最长不超过30年(10958 天) |
user_information 选填 object
【用户开卡时填写的个人信息】 用户开卡时填写的个人信息
| 属性 | |||||||||
common_field_list 选填 array[object] 【平台提供的通用开卡信息字段】 包含性别、姓名等基本信息字段
custom_field_list 选填 array[object] 【商家自定义的开卡信息字段】 商家自定义的开卡信息字段,当前最多只允许传入1项
|
attach 选填 string(256)
【商家数据包】 商家在创建用户会员卡时可传入自定义数据包,该数据对用户不可见,用于存储商家自定义信息,其总长度限制在256字符以内。查询用户会员卡详情时会将此字段返回给商家。
请求示例
PATCH
1curl -X PATCH \ 2 https://api.mch.weixin.qq.com/brand/card-member/user-cards/478515832665 \ 3 -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: PUB_KEY_ID_XXXX" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "card_id" : "pbLatjvWOibDc5-TBnbUk1pD12o0", 9 "openid" : "obLatjnx9gnqzS4myYGmLZ7LgLBA", 10 "card_color" : "#FFFF00", 11 "card_picture_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0", 12 "phone_number" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==", 13 "level" : "钻石会员", 14 "valid_date_information" : { 15 "type" : "PERMANENT", 16 "available_begin_time" : "2020-05-20T13:29:35.120+08:00", 17 "available_end_time" : "2020-05-20T13:29:35.120+08:00", 18 "available_day_after_receive" : 30 19 }, 20 "user_information" : { 21 "common_field_list" : [ 22 { 23 "name" : "USER_FORM_FLAG_BIRTHDAY", 24 "value" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==" 25 } 26 ], 27 "custom_field_list" : [ 28 { 29 "name" : "喜欢的运动", 30 "user_chosen_values" : [ 31 "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==" 32 ] 33 } 34 ] 35 }, 36 "attach" : "自定义数据说明" 37 }' 38
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayBrandUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/brand/4015826861 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 = "/brand/card-member/user-cards/{user_card_code}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 UpdateUserCard client = new UpdateUserCard( 33 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 34 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 35 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 UpdateUserCardRequest request = new UpdateUserCardRequest(); 41 request.userCardCode = "478515832665"; 42 request.cardId = "pbLatjvWOibDc5-TBnbUk1pD12o0"; 43 request.openid = "obLatjnx9gnqzS4myYGmLZ7LgLBA"; 44 request.cardColor = "#FFFF00"; 45 request.cardPictureUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0"; 46 request.phoneNumber = client.encrypt("phone_number"); 47 request.level = "钻石会员"; 48 request.validDateInformation = new DateInfo(); 49 request.validDateInformation.type = DateType.PERMANENT; 50 request.validDateInformation.availableBeginTime = "2020-05-20T13:29:35.120+08:00"; 51 request.validDateInformation.availableEndTime = "2020-05-20T13:29:35.120+08:00"; 52 request.validDateInformation.availableDayAfterReceive = 30L; 53 request.userInformation = new UserInfo(); 54 request.userInformation.commonFieldList = new ArrayList<>(); 55 { 56 UserInfoCommonField commonFieldListItem = new UserInfoCommonField(); 57 commonFieldListItem.name = CommonFieldFlag.USER_FORM_FLAG_BIRTHDAY; 58 commonFieldListItem.value = client.encrypt("value"); 59 request.userInformation.commonFieldList.add(commonFieldListItem); 60 }; 61 request.userInformation.customFieldList = new ArrayList<>(); 62 { 63 UserInfoCustomField customFieldListItem = new UserInfoCustomField(); 64 customFieldListItem.name = "喜欢的运动"; 65 customFieldListItem.userChosenValues = new ArrayList<>(); 66 { 67 customFieldListItem.userChosenValues.add("vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="); 68 }; 69 request.userInformation.customFieldList.add(customFieldListItem); 70 }; 71 request.attach = "自定义数据说明"; 72 try { 73 UserCard response = client.run(request); 74 // TODO: 请求成功,继续业务逻辑 75 System.out.println(response); 76 } catch (WXPayBrandUtility.ApiException e) { 77 // TODO: 请求失败,根据状态码执行不同的逻辑 78 e.printStackTrace(); 79 } 80 } 81 82 public UserCard run(UpdateUserCardRequest request) { 83 String uri = PATH; 84 uri = uri.replace("{user_card_code}", WXPayBrandUtility.urlEncode(request.userCardCode)); 85 String reqBody = WXPayBrandUtility.toJson(request); 86 87 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 88 reqBuilder.addHeader("Accept", "application/json"); 89 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 90 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 91 reqBuilder.addHeader("Content-Type", "application/json"); 92 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 93 reqBuilder.method(METHOD, requestBody); 94 Request httpRequest = reqBuilder.build(); 95 96 // 发送HTTP请求 97 OkHttpClient client = new OkHttpClient.Builder().build(); 98 try (Response httpResponse = client.newCall(httpRequest).execute()) { 99 String respBody = WXPayBrandUtility.extractBody(httpResponse); 100 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 101 // 2XX 成功,验证应答签名 102 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 103 httpResponse.headers(), respBody); 104 105 // 从HTTP应答报文构建返回数据 106 return WXPayBrandUtility.fromJson(respBody, UserCard.class); 107 } else { 108 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 109 } 110 } catch (IOException e) { 111 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 112 } 113 } 114 115 private final String brand_id; 116 private final String certificateSerialNo; 117 private final PrivateKey privateKey; 118 private final String wechatPayPublicKeyId; 119 private final PublicKey wechatPayPublicKey; 120 121 public UpdateUserCard(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 122 this.brand_id = brand_id; 123 this.certificateSerialNo = certificateSerialNo; 124 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 125 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 126 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 127 } 128 129 public String encrypt(String plainText) { 130 return WXPayBrandUtility.encrypt(this.wechatPayPublicKey, plainText); 131 } 132 133 public static class UpdateUserCardRequest { 134 @SerializedName("user_card_code") 135 @Expose(serialize = false) 136 public String userCardCode; 137 138 @SerializedName("card_id") 139 public String cardId; 140 141 @SerializedName("openid") 142 public String openid; 143 144 @SerializedName("card_color") 145 public String cardColor; 146 147 @SerializedName("card_picture_url") 148 public String cardPictureUrl; 149 150 @SerializedName("phone_number") 151 public String phoneNumber; 152 153 @SerializedName("level") 154 public String level; 155 156 @SerializedName("valid_date_information") 157 public DateInfo validDateInformation; 158 159 @SerializedName("user_information") 160 public UserInfo userInformation; 161 162 @SerializedName("attach") 163 public String attach; 164 } 165 166 public static class UserCard { 167 @SerializedName("user_card_code") 168 public String userCardCode; 169 170 @SerializedName("card_id") 171 public String cardId; 172 173 @SerializedName("openid") 174 public String openid; 175 176 @SerializedName("card_color") 177 public String cardColor; 178 179 @SerializedName("card_picture_url") 180 public String cardPictureUrl; 181 182 @SerializedName("brand_id") 183 public String brandId; 184 185 @SerializedName("card_type") 186 public CardType cardType; 187 188 @SerializedName("phone_number") 189 public String phoneNumber; 190 191 @SerializedName("level") 192 public String level; 193 194 @SerializedName("valid_date_information") 195 public DateInfo validDateInformation; 196 197 @SerializedName("pickup_time") 198 public String pickupTime; 199 200 @SerializedName("user_information") 201 public UserInfo userInformation; 202 203 @SerializedName("attach") 204 public String attach; 205 206 @SerializedName("user_card_state") 207 public UserCardState userCardState; 208 209 @SerializedName("invalid_reason") 210 public String invalidReason; 211 212 @SerializedName("invalid_time") 213 public String invalidTime; 214 215 @SerializedName("create_time") 216 public String createTime; 217 218 @SerializedName("modify_time") 219 public String modifyTime; 220 } 221 222 public static class DateInfo { 223 @SerializedName("type") 224 public DateType type; 225 226 @SerializedName("available_begin_time") 227 public String availableBeginTime; 228 229 @SerializedName("available_end_time") 230 public String availableEndTime; 231 232 @SerializedName("available_day_after_receive") 233 public Long availableDayAfterReceive; 234 } 235 236 public static class UserInfo { 237 @SerializedName("common_field_list") 238 public List<UserInfoCommonField> commonFieldList; 239 240 @SerializedName("custom_field_list") 241 public List<UserInfoCustomField> customFieldList; 242 } 243 244 public enum CardType { 245 @SerializedName("PURCHASE") 246 PURCHASE, 247 @SerializedName("NORMAL") 248 NORMAL, 249 @SerializedName("BALANCE") 250 BALANCE 251 } 252 253 public enum UserCardState { 254 @SerializedName("UNACTIVATED") 255 UNACTIVATED, 256 @SerializedName("EFFECTIVE") 257 EFFECTIVE, 258 @SerializedName("EXPIRED") 259 EXPIRED, 260 @SerializedName("INVALID") 261 INVALID 262 } 263 264 public enum DateType { 265 @SerializedName("FIX_TIME_RANGE") 266 FIX_TIME_RANGE, 267 @SerializedName("FIX_TERM") 268 FIX_TERM, 269 @SerializedName("PERMANENT") 270 PERMANENT 271 } 272 273 public static class UserInfoCommonField { 274 @SerializedName("name") 275 public CommonFieldFlag name; 276 277 @SerializedName("value") 278 public String value; 279 } 280 281 public static class UserInfoCustomField { 282 @SerializedName("name") 283 public String name; 284 285 @SerializedName("user_chosen_values") 286 public List<String> userChosenValues; 287 } 288 289 public enum CommonFieldFlag { 290 @SerializedName("USER_FORM_FLAG_SEX") 291 USER_FORM_FLAG_SEX, 292 @SerializedName("USER_FORM_FLAG_NAME") 293 USER_FORM_FLAG_NAME, 294 @SerializedName("USER_FORM_FLAG_BIRTHDAY") 295 USER_FORM_FLAG_BIRTHDAY, 296 @SerializedName("USER_FORM_FLAG_ADDRESS") 297 USER_FORM_FLAG_ADDRESS, 298 @SerializedName("USER_FORM_FLAG_EMAIL") 299 USER_FORM_FLAG_EMAIL, 300 @SerializedName("USER_FORM_FLAG_CITY") 301 USER_FORM_FLAG_CITY 302 } 303 304} 305
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_brand_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/brand/4015826866 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10 "strings" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 15 config, err := wxpay_brand_utility.CreateBrandConfig( 16 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 17 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 18 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &UpdateUserCardRequest{ 28 UserCardCode: wxpay_brand_utility.String("478515832665"), 29 CardId: wxpay_brand_utility.String("pbLatjvWOibDc5-TBnbUk1pD12o0"), 30 Openid: wxpay_brand_utility.String("obLatjnx9gnqzS4myYGmLZ7LgLBA"), 31 CardColor: wxpay_brand_utility.String("#FFFF00"), 32 CardPictureUrl: wxpay_brand_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0"), 33 PhoneNumber: wxpay_brand_utility.String("vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="), /*请传入wxpay_brand_utility.EncryptOAEPWithPublicKey 加密结果*/ 34 Level: wxpay_brand_utility.String("钻石会员"), 35 ValidDateInformation: &DateInfo{ 36 Type: DATETYPE_PERMANENT.Ptr(), 37 AvailableBeginTime: wxpay_brand_utility.String("2020-05-20T13:29:35.120+08:00"), 38 AvailableEndTime: wxpay_brand_utility.String("2020-05-20T13:29:35.120+08:00"), 39 AvailableDayAfterReceive: wxpay_brand_utility.Int64(30), 40 }, 41 UserInformation: &UserInfo{ 42 CommonFieldList: []UserInfoCommonField{UserInfoCommonField{ 43 Name: COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY.Ptr(), 44 Value: wxpay_brand_utility.String("vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="), /*请传入wxpay_brand_utility.EncryptOAEPWithPublicKey 加密结果*/ 45 }}, 46 CustomFieldList: []UserInfoCustomField{UserInfoCustomField{ 47 Name: wxpay_brand_utility.String("喜欢的运动"), 48 UserChosenValues: []string{"vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="}, 49 }}, 50 }, 51 Attach: wxpay_brand_utility.String("自定义数据说明"), 52 } 53 54 response, err := UpdateUserCard(config, request) 55 if err != nil { 56 fmt.Printf("请求失败: %+v\n", err) 57 // TODO: 请求失败,根据状态码执行不同的处理 58 return 59 } 60 61 // TODO: 请求成功,继续业务逻辑 62 fmt.Printf("请求成功: %+v\n", response) 63} 64 65func UpdateUserCard(config *wxpay_brand_utility.BrandConfig, request *UpdateUserCardRequest) (response *UserCard, err error) { 66 const ( 67 host = "https://api.mch.weixin.qq.com" 68 method = "PATCH" 69 path = "/brand/card-member/user-cards/{user_card_code}" 70 ) 71 72 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 73 if err != nil { 74 return nil, err 75 } 76 reqUrl.Path = strings.Replace(reqUrl.Path, "{user_card_code}", url.PathEscape(*request.UserCardCode), -1) 77 reqBody, err := json.Marshal(request) 78 if err != nil { 79 return nil, err 80 } 81 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 82 if err != nil { 83 return nil, err 84 } 85 httpRequest.Header.Set("Accept", "application/json") 86 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 87 httpRequest.Header.Set("Content-Type", "application/json") 88 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 89 if err != nil { 90 return nil, err 91 } 92 httpRequest.Header.Set("Authorization", authorization) 93 94 client := &http.Client{} 95 httpResponse, err := client.Do(httpRequest) 96 if err != nil { 97 return nil, err 98 } 99 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 100 if err != nil { 101 return nil, err 102 } 103 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 104 // 2XX 成功,验证应答签名 105 err = wxpay_brand_utility.ValidateResponse( 106 config.WechatPayPublicKeyId(), 107 config.WechatPayPublicKey(), 108 &httpResponse.Header, 109 respBody, 110 ) 111 if err != nil { 112 return nil, err 113 } 114 response := &UserCard{} 115 if err := json.Unmarshal(respBody, response); err != nil { 116 return nil, err 117 } 118 119 return response, nil 120 } else { 121 return nil, wxpay_brand_utility.NewApiException( 122 httpResponse.StatusCode, 123 httpResponse.Header, 124 respBody, 125 ) 126 } 127} 128 129type UpdateUserCardRequest struct { 130 UserCardCode *string `json:"user_card_code,omitempty"` 131 CardId *string `json:"card_id,omitempty"` 132 Openid *string `json:"openid,omitempty"` 133 CardColor *string `json:"card_color,omitempty"` 134 CardPictureUrl *string `json:"card_picture_url,omitempty"` 135 PhoneNumber *string `json:"phone_number,omitempty"` 136 Level *string `json:"level,omitempty"` 137 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 138 UserInformation *UserInfo `json:"user_information,omitempty"` 139 Attach *string `json:"attach,omitempty"` 140} 141 142func (o *UpdateUserCardRequest) MarshalJSON() ([]byte, error) { 143 type Alias UpdateUserCardRequest 144 a := &struct { 145 UserCardCode *string `json:"user_card_code,omitempty"` 146 *Alias 147 }{ 148 // 序列化时移除非 Body 字段 149 UserCardCode: nil, 150 Alias: (*Alias)(o), 151 } 152 return json.Marshal(a) 153} 154 155type UserCard struct { 156 UserCardCode *string `json:"user_card_code,omitempty"` 157 CardId *string `json:"card_id,omitempty"` 158 Openid *string `json:"openid,omitempty"` 159 CardColor *string `json:"card_color,omitempty"` 160 CardPictureUrl *string `json:"card_picture_url,omitempty"` 161 BrandId *string `json:"brand_id,omitempty"` 162 CardType *CardType `json:"card_type,omitempty"` 163 PhoneNumber *string `json:"phone_number,omitempty"` 164 Level *string `json:"level,omitempty"` 165 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 166 PickupTime *string `json:"pickup_time,omitempty"` 167 UserInformation *UserInfo `json:"user_information,omitempty"` 168 Attach *string `json:"attach,omitempty"` 169 UserCardState *UserCardState `json:"user_card_state,omitempty"` 170 InvalidReason *string `json:"invalid_reason,omitempty"` 171 InvalidTime *string `json:"invalid_time,omitempty"` 172 CreateTime *string `json:"create_time,omitempty"` 173 ModifyTime *string `json:"modify_time,omitempty"` 174} 175 176type DateInfo struct { 177 Type *DateType `json:"type,omitempty"` 178 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 179 AvailableEndTime *string `json:"available_end_time,omitempty"` 180 AvailableDayAfterReceive *int64 `json:"available_day_after_receive,omitempty"` 181} 182 183type UserInfo struct { 184 CommonFieldList []UserInfoCommonField `json:"common_field_list,omitempty"` 185 CustomFieldList []UserInfoCustomField `json:"custom_field_list,omitempty"` 186} 187 188type CardType string 189 190func (e CardType) Ptr() *CardType { 191 return &e 192} 193 194const ( 195 CARDTYPE_PURCHASE CardType = "PURCHASE" 196 CARDTYPE_NORMAL CardType = "NORMAL" 197 CARDTYPE_BALANCE CardType = "BALANCE" 198) 199 200type UserCardState string 201 202func (e UserCardState) Ptr() *UserCardState { 203 return &e 204} 205 206const ( 207 USERCARDSTATE_UNACTIVATED UserCardState = "UNACTIVATED" 208 USERCARDSTATE_EFFECTIVE UserCardState = "EFFECTIVE" 209 USERCARDSTATE_EXPIRED UserCardState = "EXPIRED" 210 USERCARDSTATE_INVALID UserCardState = "INVALID" 211) 212 213type DateType string 214 215func (e DateType) Ptr() *DateType { 216 return &e 217} 218 219const ( 220 DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE" 221 DATETYPE_FIX_TERM DateType = "FIX_TERM" 222 DATETYPE_PERMANENT DateType = "PERMANENT" 223) 224 225type UserInfoCommonField struct { 226 Name *CommonFieldFlag `json:"name,omitempty"` 227 Value *string `json:"value,omitempty"` 228} 229 230type UserInfoCustomField struct { 231 Name *string `json:"name,omitempty"` 232 UserChosenValues []string `json:"user_chosen_values,omitempty"` 233} 234 235type CommonFieldFlag string 236 237func (e CommonFieldFlag) Ptr() *CommonFieldFlag { 238 return &e 239} 240 241const ( 242 COMMONFIELDFLAG_USER_FORM_FLAG_SEX CommonFieldFlag = "USER_FORM_FLAG_SEX" 243 COMMONFIELDFLAG_USER_FORM_FLAG_NAME CommonFieldFlag = "USER_FORM_FLAG_NAME" 244 COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY" 245 COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS CommonFieldFlag = "USER_FORM_FLAG_ADDRESS" 246 COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL CommonFieldFlag = "USER_FORM_FLAG_EMAIL" 247 COMMONFIELDFLAG_USER_FORM_FLAG_CITY CommonFieldFlag = "USER_FORM_FLAG_CITY" 248) 249
应答参数
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。请查看以下链接后传入:图片要求示例,图片上传API指引
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
【会员卡有效期】 会员卡有效期
| 属性 | |
type 选填 string 【有效期类型】 1.该有效期为会员卡激活后的有效期 2.支持绝对有效期&相对有效期设置 3.绝对有效期:固定过期时间,需遵循 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秒。 4.相对有效期:用户激活后x天后有效,x为天数。最多支持10,957天(30年) 5.永久有效 6.过期后卡状态变为“已过期” 7.过期后不再出现服务项,且无法给用户发送会员服务消息通知 可选取值
available_begin_time 选填 string(32) 【有效期开始时间】 type为FIX_TIME_RANGE时专用, 表示有效期开始时间。需需遵循 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秒。 available_end_time 选填 string(32) 【有效期结束时间】 type为FIX_TERM_RANGE时专用,表示有效期结束时间。需需遵循 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秒。 available_day_after_receive 选填 integer 【领取后N天内有效】 type为FIX_TERM时专用,表示领取后N个自然天内有效。最长不超过30年(10958 天) |
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
【用户开卡时填写的个人信息】 用户开卡时填写的个人信息
| 属性 | |||||||||
common_field_list 选填 array[object] 【平台提供的通用开卡信息字段】 包含性别、姓名等基本信息字段
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 标准格式: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
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

