同步会员开通结果
更新时间:2025.07.16用户通过入会组件和商家名片开卡后,微信支付会回调通知给商家,且商家必须再把开卡结果同步给微信支付侧才算开卡成功(注意:通过API导入和下单同步等方式无需同步开卡结果)。在同步开卡结果时商家可修改部分会员卡信息
接口限频:按品牌商户品牌 ID 维度 5 次/秒
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/card-member/user-cards/{user_card_code}/confirm
请求域名:【主域名】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字符以内。查询用户会员卡详情时会将此字段返回给商家。
user_card_confirm_state 必填 string
【会员开卡状态】 商家需要同步会员开卡状态
可选取值
CREATE_CARD_SUCCESS: 开卡成功CREATE_CARD_FAIL: 开卡失败CREATE_CARD_ALREADY_EXISTS: 开卡成功但已在其他渠道入会
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/card-member/user-cards/478515832665/confirm \ 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 "user_card_confirm_state" : "CREATE_CARD_SUCCESS" 38 }' 39
需配合微信支付工具库 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 ConfirmUserCard { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/brand/card-member/user-cards/{user_card_code}/confirm"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 ConfirmUserCard client = new ConfirmUserCard( 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 ConfirmUserCardRequest request = new ConfirmUserCardRequest(); 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 request.userCardConfirmState = UserCardConfirmState.CREATE_CARD_SUCCESS; 73 try { 74 UserCard response = client.run(request); 75 // TODO: 请求成功,继续业务逻辑 76 System.out.println(response); 77 } catch (WXPayBrandUtility.ApiException e) { 78 // TODO: 请求失败,根据状态码执行不同的逻辑 79 e.printStackTrace(); 80 } 81 } 82 83 public UserCard run(ConfirmUserCardRequest request) { 84 String uri = PATH; 85 uri = uri.replace("{user_card_code}", WXPayBrandUtility.urlEncode(request.userCardCode)); 86 String reqBody = WXPayBrandUtility.toJson(request); 87 88 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 89 reqBuilder.addHeader("Accept", "application/json"); 90 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 91 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 92 reqBuilder.addHeader("Content-Type", "application/json"); 93 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 94 reqBuilder.method(METHOD, requestBody); 95 Request httpRequest = reqBuilder.build(); 96 97 // 发送HTTP请求 98 OkHttpClient client = new OkHttpClient.Builder().build(); 99 try (Response httpResponse = client.newCall(httpRequest).execute()) { 100 String respBody = WXPayBrandUtility.extractBody(httpResponse); 101 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 102 // 2XX 成功,验证应答签名 103 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 104 httpResponse.headers(), respBody); 105 106 // 从HTTP应答报文构建返回数据 107 return WXPayBrandUtility.fromJson(respBody, UserCard.class); 108 } else { 109 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 110 } 111 } catch (IOException e) { 112 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 113 } 114 } 115 116 private final String brand_id; 117 private final String certificateSerialNo; 118 private final PrivateKey privateKey; 119 private final String wechatPayPublicKeyId; 120 private final PublicKey wechatPayPublicKey; 121 122 public ConfirmUserCard(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 123 this.brand_id = brand_id; 124 this.certificateSerialNo = certificateSerialNo; 125 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 126 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 127 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 128 } 129 130 public String encrypt(String plainText) { 131 return WXPayBrandUtility.encrypt(this.wechatPayPublicKey, plainText); 132 } 133 134 public static class ConfirmUserCardRequest { 135 @SerializedName("user_card_code") 136 @Expose(serialize = false) 137 public String userCardCode; 138 139 @SerializedName("card_id") 140 public String cardId; 141 142 @SerializedName("openid") 143 public String openid; 144 145 @SerializedName("card_color") 146 public String cardColor; 147 148 @SerializedName("card_picture_url") 149 public String cardPictureUrl; 150 151 @SerializedName("phone_number") 152 public String phoneNumber; 153 154 @SerializedName("level") 155 public String level; 156 157 @SerializedName("valid_date_information") 158 public DateInfo validDateInformation; 159 160 @SerializedName("user_information") 161 public UserInfo userInformation; 162 163 @SerializedName("attach") 164 public String attach; 165 166 @SerializedName("user_card_confirm_state") 167 public UserCardConfirmState userCardConfirmState; 168 } 169 170 public static class UserCard { 171 @SerializedName("user_card_code") 172 public String userCardCode; 173 174 @SerializedName("card_id") 175 public String cardId; 176 177 @SerializedName("openid") 178 public String openid; 179 180 @SerializedName("card_color") 181 public String cardColor; 182 183 @SerializedName("card_picture_url") 184 public String cardPictureUrl; 185 186 @SerializedName("brand_id") 187 public String brandId; 188 189 @SerializedName("card_type") 190 public CardType cardType; 191 192 @SerializedName("phone_number") 193 public String phoneNumber; 194 195 @SerializedName("level") 196 public String level; 197 198 @SerializedName("valid_date_information") 199 public DateInfo validDateInformation; 200 201 @SerializedName("pickup_time") 202 public String pickupTime; 203 204 @SerializedName("user_information") 205 public UserInfo userInformation; 206 207 @SerializedName("attach") 208 public String attach; 209 210 @SerializedName("user_card_state") 211 public UserCardState userCardState; 212 213 @SerializedName("invalid_reason") 214 public String invalidReason; 215 216 @SerializedName("invalid_time") 217 public String invalidTime; 218 219 @SerializedName("create_time") 220 public String createTime; 221 222 @SerializedName("modify_time") 223 public String modifyTime; 224 } 225 226 public static class DateInfo { 227 @SerializedName("type") 228 public DateType type; 229 230 @SerializedName("available_begin_time") 231 public String availableBeginTime; 232 233 @SerializedName("available_end_time") 234 public String availableEndTime; 235 236 @SerializedName("available_day_after_receive") 237 public Long availableDayAfterReceive; 238 } 239 240 public static class UserInfo { 241 @SerializedName("common_field_list") 242 public List<UserInfoCommonField> commonFieldList; 243 244 @SerializedName("custom_field_list") 245 public List<UserInfoCustomField> customFieldList; 246 } 247 248 public enum UserCardConfirmState { 249 @SerializedName("CREATE_CARD_SUCCESS") 250 CREATE_CARD_SUCCESS, 251 @SerializedName("CREATE_CARD_FAIL") 252 CREATE_CARD_FAIL, 253 @SerializedName("CREATE_CARD_ALREADY_EXISTS") 254 CREATE_CARD_ALREADY_EXISTS 255 } 256 257 public enum CardType { 258 @SerializedName("PURCHASE") 259 PURCHASE, 260 @SerializedName("NORMAL") 261 NORMAL, 262 @SerializedName("BALANCE") 263 BALANCE 264 } 265 266 public enum UserCardState { 267 @SerializedName("UNACTIVATED") 268 UNACTIVATED, 269 @SerializedName("EFFECTIVE") 270 EFFECTIVE, 271 @SerializedName("EXPIRED") 272 EXPIRED, 273 @SerializedName("INVALID") 274 INVALID 275 } 276 277 public enum DateType { 278 @SerializedName("FIX_TIME_RANGE") 279 FIX_TIME_RANGE, 280 @SerializedName("FIX_TERM") 281 FIX_TERM, 282 @SerializedName("PERMANENT") 283 PERMANENT 284 } 285 286 public static class UserInfoCommonField { 287 @SerializedName("name") 288 public CommonFieldFlag name; 289 290 @SerializedName("value") 291 public String value; 292 } 293 294 public static class UserInfoCustomField { 295 @SerializedName("name") 296 public String name; 297 298 @SerializedName("user_chosen_values") 299 public List<String> userChosenValues; 300 } 301 302 public enum CommonFieldFlag { 303 @SerializedName("USER_FORM_FLAG_SEX") 304 USER_FORM_FLAG_SEX, 305 @SerializedName("USER_FORM_FLAG_NAME") 306 USER_FORM_FLAG_NAME, 307 @SerializedName("USER_FORM_FLAG_BIRTHDAY") 308 USER_FORM_FLAG_BIRTHDAY, 309 @SerializedName("USER_FORM_FLAG_ADDRESS") 310 USER_FORM_FLAG_ADDRESS, 311 @SerializedName("USER_FORM_FLAG_EMAIL") 312 USER_FORM_FLAG_EMAIL, 313 @SerializedName("USER_FORM_FLAG_CITY") 314 USER_FORM_FLAG_CITY 315 } 316 317} 318
需配合微信支付工具库 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 := &ConfirmUserCardRequest{ 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 UserCardConfirmState: USERCARDCONFIRMSTATE_CREATE_CARD_SUCCESS.Ptr(), 53 } 54 55 response, err := ConfirmUserCard(config, request) 56 if err != nil { 57 fmt.Printf("请求失败: %+v\n", err) 58 // TODO: 请求失败,根据状态码执行不同的处理 59 return 60 } 61 62 // TODO: 请求成功,继续业务逻辑 63 fmt.Printf("请求成功: %+v\n", response) 64} 65 66func ConfirmUserCard(config *wxpay_brand_utility.BrandConfig, request *ConfirmUserCardRequest) (response *UserCard, err error) { 67 const ( 68 host = "https://api.mch.weixin.qq.com" 69 method = "POST" 70 path = "/brand/card-member/user-cards/{user_card_code}/confirm" 71 ) 72 73 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 74 if err != nil { 75 return nil, err 76 } 77 reqUrl.Path = strings.Replace(reqUrl.Path, "{user_card_code}", url.PathEscape(*request.UserCardCode), -1) 78 reqBody, err := json.Marshal(request) 79 if err != nil { 80 return nil, err 81 } 82 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 83 if err != nil { 84 return nil, err 85 } 86 httpRequest.Header.Set("Accept", "application/json") 87 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 88 httpRequest.Header.Set("Content-Type", "application/json") 89 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 90 if err != nil { 91 return nil, err 92 } 93 httpRequest.Header.Set("Authorization", authorization) 94 95 client := &http.Client{} 96 httpResponse, err := client.Do(httpRequest) 97 if err != nil { 98 return nil, err 99 } 100 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 101 if err != nil { 102 return nil, err 103 } 104 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 105 // 2XX 成功,验证应答签名 106 err = wxpay_brand_utility.ValidateResponse( 107 config.WechatPayPublicKeyId(), 108 config.WechatPayPublicKey(), 109 &httpResponse.Header, 110 respBody, 111 ) 112 if err != nil { 113 return nil, err 114 } 115 response := &UserCard{} 116 if err := json.Unmarshal(respBody, response); err != nil { 117 return nil, err 118 } 119 120 return response, nil 121 } else { 122 return nil, wxpay_brand_utility.NewApiException( 123 httpResponse.StatusCode, 124 httpResponse.Header, 125 respBody, 126 ) 127 } 128} 129 130type ConfirmUserCardRequest struct { 131 UserCardCode *string `json:"user_card_code,omitempty"` 132 CardId *string `json:"card_id,omitempty"` 133 Openid *string `json:"openid,omitempty"` 134 CardColor *string `json:"card_color,omitempty"` 135 CardPictureUrl *string `json:"card_picture_url,omitempty"` 136 PhoneNumber *string `json:"phone_number,omitempty"` 137 Level *string `json:"level,omitempty"` 138 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 139 UserInformation *UserInfo `json:"user_information,omitempty"` 140 Attach *string `json:"attach,omitempty"` 141 UserCardConfirmState *UserCardConfirmState `json:"user_card_confirm_state,omitempty"` 142} 143 144func (o *ConfirmUserCardRequest) MarshalJSON() ([]byte, error) { 145 type Alias ConfirmUserCardRequest 146 a := &struct { 147 UserCardCode *string `json:"user_card_code,omitempty"` 148 *Alias 149 }{ 150 // 序列化时移除非 Body 字段 151 UserCardCode: nil, 152 Alias: (*Alias)(o), 153 } 154 return json.Marshal(a) 155} 156 157type UserCard struct { 158 UserCardCode *string `json:"user_card_code,omitempty"` 159 CardId *string `json:"card_id,omitempty"` 160 Openid *string `json:"openid,omitempty"` 161 CardColor *string `json:"card_color,omitempty"` 162 CardPictureUrl *string `json:"card_picture_url,omitempty"` 163 BrandId *string `json:"brand_id,omitempty"` 164 CardType *CardType `json:"card_type,omitempty"` 165 PhoneNumber *string `json:"phone_number,omitempty"` 166 Level *string `json:"level,omitempty"` 167 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 168 PickupTime *string `json:"pickup_time,omitempty"` 169 UserInformation *UserInfo `json:"user_information,omitempty"` 170 Attach *string `json:"attach,omitempty"` 171 UserCardState *UserCardState `json:"user_card_state,omitempty"` 172 InvalidReason *string `json:"invalid_reason,omitempty"` 173 InvalidTime *string `json:"invalid_time,omitempty"` 174 CreateTime *string `json:"create_time,omitempty"` 175 ModifyTime *string `json:"modify_time,omitempty"` 176} 177 178type DateInfo struct { 179 Type *DateType `json:"type,omitempty"` 180 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 181 AvailableEndTime *string `json:"available_end_time,omitempty"` 182 AvailableDayAfterReceive *int64 `json:"available_day_after_receive,omitempty"` 183} 184 185type UserInfo struct { 186 CommonFieldList []UserInfoCommonField `json:"common_field_list,omitempty"` 187 CustomFieldList []UserInfoCustomField `json:"custom_field_list,omitempty"` 188} 189 190type UserCardConfirmState string 191 192func (e UserCardConfirmState) Ptr() *UserCardConfirmState { 193 return &e 194} 195 196const ( 197 USERCARDCONFIRMSTATE_CREATE_CARD_SUCCESS UserCardConfirmState = "CREATE_CARD_SUCCESS" 198 USERCARDCONFIRMSTATE_CREATE_CARD_FAIL UserCardConfirmState = "CREATE_CARD_FAIL" 199 USERCARDCONFIRMSTATE_CREATE_CARD_ALREADY_EXISTS UserCardConfirmState = "CREATE_CARD_ALREADY_EXISTS" 200) 201 202type CardType string 203 204func (e CardType) Ptr() *CardType { 205 return &e 206} 207 208const ( 209 CARDTYPE_PURCHASE CardType = "PURCHASE" 210 CARDTYPE_NORMAL CardType = "NORMAL" 211 CARDTYPE_BALANCE CardType = "BALANCE" 212) 213 214type UserCardState string 215 216func (e UserCardState) Ptr() *UserCardState { 217 return &e 218} 219 220const ( 221 USERCARDSTATE_UNACTIVATED UserCardState = "UNACTIVATED" 222 USERCARDSTATE_EFFECTIVE UserCardState = "EFFECTIVE" 223 USERCARDSTATE_EXPIRED UserCardState = "EXPIRED" 224 USERCARDSTATE_INVALID UserCardState = "INVALID" 225) 226 227type DateType string 228 229func (e DateType) Ptr() *DateType { 230 return &e 231} 232 233const ( 234 DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE" 235 DATETYPE_FIX_TERM DateType = "FIX_TERM" 236 DATETYPE_PERMANENT DateType = "PERMANENT" 237) 238 239type UserInfoCommonField struct { 240 Name *CommonFieldFlag `json:"name,omitempty"` 241 Value *string `json:"value,omitempty"` 242} 243 244type UserInfoCustomField struct { 245 Name *string `json:"name,omitempty"` 246 UserChosenValues []string `json:"user_chosen_values,omitempty"` 247} 248 249type CommonFieldFlag string 250 251func (e CommonFieldFlag) Ptr() *CommonFieldFlag { 252 return &e 253} 254 255const ( 256 COMMONFIELDFLAG_USER_FORM_FLAG_SEX CommonFieldFlag = "USER_FORM_FLAG_SEX" 257 COMMONFIELDFLAG_USER_FORM_FLAG_NAME CommonFieldFlag = "USER_FORM_FLAG_NAME" 258 COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY" 259 COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS CommonFieldFlag = "USER_FORM_FLAG_ADDRESS" 260 COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL CommonFieldFlag = "USER_FORM_FLAG_EMAIL" 261 COMMONFIELDFLAG_USER_FORM_FLAG_CITY CommonFieldFlag = "USER_FORM_FLAG_CITY" 262) 263
应答参数
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
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

