根据手机号导入用户会员卡
更新时间:2025.06.22对于经营会员生意的商家来说,存量会员的注册渠道广泛,包括但不限于线下渠道、微信渠道、App及其他线上渠道。因而,在微信生态下经营会员时常遇到两类问题:
(1)存量会员的身份难统一识别;
(2)在应用「开卡有礼」活动能力时,容易对存量(但未同步身份至微信侧的)老会员重复补贴。
因而,若商家侧存在较多线下渠道注册的存量会员,则商家可通过加密后的用户手机号,将存量会员通过接口导入至微信侧后台。
注意:1、“导入”仅为后台操作,微信会员卡系统会在后台将用户的会员卡静默激活,但不会在用户卡包中自动出现该会员卡,建议商家侧后续在其他路径引导用户主动添加会员卡到卡包;2、用户手机号,需调用方按接口文档要求加密后再传入。
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/brand/partner/card-member/user-cards/import-by-phone
请求域名:【主域名】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说明以及微信支付公钥加密敏感信息指引;也可以使用微信支付平台证书公钥加密,参考获取平台证书序列号、平台证书加密敏感信息指引
body 包体参数
brand_id 必填 string(32)
【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方
card_id 必填 string(32)
【会员卡模版ID】 商家创建微信会员卡模板成功后系统返回的会员卡模板ID
phone_number 必填 string(512)
【加密的手机号】 注册会员的手机号码。该字段需要使用微信支付公钥加密(推荐),请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引,也可以使用微信支付平台证书公钥加密,参考获取平台证书序列号、平台证书加密敏感信息指引。
user_card_code 必填 string(32)
【会员卡code】 会员在一个会员卡模版下的唯一标识,用户领取会员卡后获得的code
card_color 选填 string(7)
【卡背景颜色】 用于卡片正面设计的RGB颜色编码,仅支持十六进制
card_picture_url 选填 string(256)
【卡图片】 商家自定义会员卡背景图。仅支持通过图片上传API接口获取的图片URL地址。支持JPG/JPEG/PNG格式,建议尺寸716px*320px,且图片小于1M。查看以下链接后传入:图片要求示例,图片上传API指引。
level 选填 string(10)
【等级】 用户会员等级,展示字段,商家可以自定义填写内容。
user_information 选填 object
【用户开卡时填写的个人信息】 用户开卡时填写的个人信息
属性 | |||||||||
common_field_list 选填 array[object] 【平台提供的通用开卡信息字段】 包含性别、手机、头像、昵称、姓名等基本信息字段
custom_field_list 选填 array[object] 【商家自定义的开卡信息字段】 商家自定义的开卡信息字段,当前最多只允许传入1项
|
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)
【领取时间】 用户领取会员卡的时间。仅在会员卡有效期类型是FIX_TERM时需要填写,领取时间必须早于当前时间,且不允许导入已过期的会员卡。需遵循 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秒。
请求示例
需配合微信支付工具库 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 ImportUserCardByPhoneNumber { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/brand/partner/card-member/user-cards/import-by-phone"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 ImportUserCardByPhoneNumber client = new ImportUserCardByPhoneNumber( 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 ImportUserCardByPhoneNumberRequest request = new ImportUserCardByPhoneNumberRequest(); 41 request.brandId = "1004"; 42 request.cardId = "pbLatjvWOibDc5-TBnbUk1pD12o0"; 43 request.phoneNumber = client.encrypt("phone_number"); 44 request.userCardCode = "478515832665"; 45 request.cardColor = "#FFFF00"; 46 request.cardPictureUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0"; 47 request.level = "钻石会员"; 48 request.userInformation = new UserInfo(); 49 request.userInformation.commonFieldList = new ArrayList<>(); 50 { 51 UserInfoCommonField commonFieldListItem = new UserInfoCommonField(); 52 commonFieldListItem.name = CommonFieldFlag.USER_FORM_FLAG_BIRTHDAY; 53 commonFieldListItem.value = client.encrypt("value"); 54 request.userInformation.commonFieldList.add(commonFieldListItem); 55 }; 56 request.userInformation.customFieldList = new ArrayList<>(); 57 { 58 UserInfoCustomField customFieldListItem = new UserInfoCustomField(); 59 customFieldListItem.name = "喜欢的运动"; 60 customFieldListItem.userChosenValues = new ArrayList<>(); 61 { 62 customFieldListItem.userChosenValues.add("vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="); 63 }; 64 request.userInformation.customFieldList.add(customFieldListItem); 65 }; 66 request.validDateInformation = new DateInfo(); 67 request.validDateInformation.type = DateType.PERMANENT; 68 request.validDateInformation.availableBeginTime = "2020-05-20T13:29:35.120+08:00"; 69 request.validDateInformation.availableEndTime = "2020-05-20T13:29:35.120+08:00"; 70 request.validDateInformation.availableDayAfterReceive = 30L; 71 request.pickupTime = "2020-05-20T13:29:35.120+08:00"; 72 try { 73 UserCard response = client.run(request); 74 75 // TODO: 请求成功,继续业务逻辑 76 System.out.println(response); 77 } catch (WXPayUtility.ApiException e) { 78 // TODO: 请求失败,根据状态码执行不同的逻辑 79 e.printStackTrace(); 80 } 81 } 82 83 public UserCard run(ImportUserCardByPhoneNumberRequest request) { 84 String uri = PATH; 85 String reqBody = WXPayUtility.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", WXPayUtility.buildAuthorization(mchid, 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 = WXPayUtility.extractBody(httpResponse); 100 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 101 // 2XX 成功,验证应答签名 102 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 103 httpResponse.headers(), respBody); 104 105 // 从HTTP应答报文构建返回数据 106 return WXPayUtility.fromJson(respBody, UserCard.class); 107 } else { 108 throw new WXPayUtility.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 mchid; 116 private final String certificateSerialNo; 117 private final PrivateKey privateKey; 118 private final String wechatPayPublicKeyId; 119 private final PublicKey wechatPayPublicKey; 120 121 public ImportUserCardByPhoneNumber(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 122 this.mchid = mchid; 123 this.certificateSerialNo = certificateSerialNo; 124 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 125 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 126 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 127 } 128 129 public String encrypt(String plainText) { 130 return WXPayUtility.encrypt(this.wechatPayPublicKey, plainText); 131 } 132 133 public static class ImportUserCardByPhoneNumberRequest { 134 @SerializedName("brand_id") 135 public String brandId; 136 137 @SerializedName("card_id") 138 public String cardId; 139 140 @SerializedName("phone_number") 141 public String phoneNumber; 142 143 @SerializedName("user_card_code") 144 public String userCardCode; 145 146 @SerializedName("card_color") 147 public String cardColor; 148 149 @SerializedName("card_picture_url") 150 public String cardPictureUrl; 151 152 @SerializedName("level") 153 public String level; 154 155 @SerializedName("user_information") 156 public UserInfo userInformation; 157 158 @SerializedName("valid_date_information") 159 public DateInfo validDateInformation; 160 161 @SerializedName("pickup_time") 162 public String pickupTime; 163 } 164 165 public static class UserCard { 166 @SerializedName("user_card_code") 167 public String userCardCode; 168 169 @SerializedName("card_id") 170 public String cardId; 171 172 @SerializedName("openid") 173 public String openid; 174 175 @SerializedName("card_color") 176 public String cardColor; 177 178 @SerializedName("card_picture_url") 179 public String cardPictureUrl; 180 181 @SerializedName("brand_id") 182 public String brandId; 183 184 @SerializedName("card_type") 185 public CardType cardType; 186 187 @SerializedName("phone_number") 188 public String phoneNumber; 189 190 @SerializedName("level") 191 public String level; 192 193 @SerializedName("valid_date_information") 194 public DateInfo validDateInformation; 195 196 @SerializedName("pickup_time") 197 public String pickupTime; 198 199 @SerializedName("user_information") 200 public UserInfo userInformation; 201 202 @SerializedName("attach") 203 public String attach; 204 205 @SerializedName("user_card_state") 206 public UserCardState userCardState; 207 208 @SerializedName("invalid_reason") 209 public String invalidReason; 210 211 @SerializedName("invalid_time") 212 public String invalidTime; 213 214 @SerializedName("create_time") 215 public String createTime; 216 217 @SerializedName("modify_time") 218 public String modifyTime; 219 } 220 221 public static class UserInfo { 222 @SerializedName("common_field_list") 223 public List<UserInfoCommonField> commonFieldList; 224 225 @SerializedName("custom_field_list") 226 public List<UserInfoCustomField> customFieldList; 227 } 228 229 public static class DateInfo { 230 @SerializedName("type") 231 public DateType type; 232 233 @SerializedName("available_begin_time") 234 public String availableBeginTime; 235 236 @SerializedName("available_end_time") 237 public String availableEndTime; 238 239 @SerializedName("available_day_after_receive") 240 public Long availableDayAfterReceive; 241 } 242 243 public enum CardType { 244 @SerializedName("PURCHASE") 245 PURCHASE, 246 @SerializedName("NORMAL") 247 NORMAL, 248 @SerializedName("BALANCE") 249 BALANCE 250 } 251 252 public enum UserCardState { 253 @SerializedName("UNACTIVATED") 254 UNACTIVATED, 255 @SerializedName("EFFECTIVE") 256 EFFECTIVE, 257 @SerializedName("EXPIRED") 258 EXPIRED, 259 @SerializedName("INVALID") 260 INVALID 261 } 262 263 public static class UserInfoCommonField { 264 @SerializedName("name") 265 public CommonFieldFlag name; 266 267 @SerializedName("value") 268 public String value; 269 } 270 271 public static class UserInfoCustomField { 272 @SerializedName("name") 273 public String name; 274 275 @SerializedName("user_chosen_values") 276 public List<String> userChosenValues; 277 } 278 279 public enum DateType { 280 @SerializedName("FIX_TIME_RANGE") 281 FIX_TIME_RANGE, 282 @SerializedName("FIX_TERM") 283 FIX_TERM, 284 @SerializedName("PERMANENT") 285 PERMANENT 286 } 287 288 public enum CommonFieldFlag { 289 @SerializedName("USER_FORM_FLAG_SEX") 290 USER_FORM_FLAG_SEX, 291 @SerializedName("USER_FORM_FLAG_NAME") 292 USER_FORM_FLAG_NAME, 293 @SerializedName("USER_FORM_FLAG_BIRTHDAY") 294 USER_FORM_FLAG_BIRTHDAY, 295 @SerializedName("USER_FORM_FLAG_ADDRESS") 296 USER_FORM_FLAG_ADDRESS, 297 @SerializedName("USER_FORM_FLAG_EMAIL") 298 USER_FORM_FLAG_EMAIL, 299 @SerializedName("USER_FORM_FLAG_CITY") 300 USER_FORM_FLAG_CITY 301 } 302 303} 304
需配合微信支付工具库 wxpay_utility 使用,请参考 Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &ImportUserCardByPhoneNumberRequest{ 27 BrandId: wxpay_utility.String("1004"), 28 CardId: wxpay_utility.String("pbLatjvWOibDc5-TBnbUk1pD12o0"), 29 PhoneNumber: wxpay_utility.String("vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="), /*请传入 wxpay_utility.EncryptOAEPWithPublicKey 加密结果*/ 30 UserCardCode: wxpay_utility.String("478515832665"), 31 CardColor: wxpay_utility.String("#FFFF00"), 32 CardPictureUrl: wxpay_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0"), 33 Level: wxpay_utility.String("钻石会员"), 34 UserInformation: &UserInfo{ 35 CommonFieldList: []UserInfoCommonField{UserInfoCommonField{ 36 Name: COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY.Ptr(), 37 Value: wxpay_utility.String("vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="), /*请传入 wxpay_utility.EncryptOAEPWithPublicKey 加密结果*/ 38 }}, 39 CustomFieldList: []UserInfoCustomField{UserInfoCustomField{ 40 Name: wxpay_utility.String("喜欢的运动"), 41 UserChosenValues: []string{"vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A=="}, 42 }}, 43 }, 44 ValidDateInformation: &DateInfo{ 45 Type: DATETYPE_PERMANENT.Ptr(), 46 AvailableBeginTime: wxpay_utility.String("2020-05-20T13:29:35.120+08:00"), 47 AvailableEndTime: wxpay_utility.String("2020-05-20T13:29:35.120+08:00"), 48 AvailableDayAfterReceive: wxpay_utility.Int64(30), 49 }, 50 PickupTime: wxpay_utility.String("2020-05-20T13:29:35.120+08:00"), 51 } 52 53 response, err := ImportUserCardByPhoneNumber(config, request) 54 if err != nil { 55 fmt.Printf("请求失败: %+v\n", err) 56 // TODO: 请求失败,根据状态码执行不同的处理 57 return 58 } 59 60 // TODO: 请求成功,继续业务逻辑 61 fmt.Printf("请求成功: %+v\n", response) 62} 63 64func ImportUserCardByPhoneNumber(config *wxpay_utility.MchConfig, request *ImportUserCardByPhoneNumberRequest) (response *UserCard, err error) { 65 const ( 66 host = "https://api.mch.weixin.qq.com" 67 method = "POST" 68 path = "/v3/brand/partner/card-member/user-cards/import-by-phone" 69 ) 70 71 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 72 if err != nil { 73 return nil, err 74 } 75 reqBody, err := json.Marshal(request) 76 if err != nil { 77 return nil, err 78 } 79 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 80 if err != nil { 81 return nil, err 82 } 83 httpRequest.Header.Set("Accept", "application/json") 84 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 85 httpRequest.Header.Set("Content-Type", "application/json") 86 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 87 if err != nil { 88 return nil, err 89 } 90 httpRequest.Header.Set("Authorization", authorization) 91 92 client := &http.Client{} 93 httpResponse, err := client.Do(httpRequest) 94 if err != nil { 95 return nil, err 96 } 97 98 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 99 if err != nil { 100 return nil, err 101 } 102 103 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 104 // 2XX 成功,验证应答签名 105 err = wxpay_utility.ValidateResponse( 106 config.WechatPayPublicKeyId(), 107 config.WechatPayPublicKey(), 108 &httpResponse.Header, 109 respBody, 110 ) 111 if err != nil { 112 return nil, err 113 } 114 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_utility.NewApiException( 122 httpResponse.StatusCode, 123 httpResponse.Header, 124 respBody, 125 ) 126 } 127} 128 129type ImportUserCardByPhoneNumberRequest struct { 130 BrandId *string `json:"brand_id,omitempty"` 131 CardId *string `json:"card_id,omitempty"` 132 PhoneNumber *string `json:"phone_number,omitempty"` 133 UserCardCode *string `json:"user_card_code,omitempty"` 134 CardColor *string `json:"card_color,omitempty"` 135 CardPictureUrl *string `json:"card_picture_url,omitempty"` 136 Level *string `json:"level,omitempty"` 137 UserInformation *UserInfo `json:"user_information,omitempty"` 138 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 139 PickupTime *string `json:"pickup_time,omitempty"` 140} 141 142type UserCard struct { 143 UserCardCode *string `json:"user_card_code,omitempty"` 144 CardId *string `json:"card_id,omitempty"` 145 Openid *string `json:"openid,omitempty"` 146 CardColor *string `json:"card_color,omitempty"` 147 CardPictureUrl *string `json:"card_picture_url,omitempty"` 148 BrandId *string `json:"brand_id,omitempty"` 149 CardType *CardType `json:"card_type,omitempty"` 150 PhoneNumber *string `json:"phone_number,omitempty"` 151 Level *string `json:"level,omitempty"` 152 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 153 PickupTime *string `json:"pickup_time,omitempty"` 154 UserInformation *UserInfo `json:"user_information,omitempty"` 155 Attach *string `json:"attach,omitempty"` 156 UserCardState *UserCardState `json:"user_card_state,omitempty"` 157 InvalidReason *string `json:"invalid_reason,omitempty"` 158 InvalidTime *string `json:"invalid_time,omitempty"` 159 CreateTime *string `json:"create_time,omitempty"` 160 ModifyTime *string `json:"modify_time,omitempty"` 161} 162 163type UserInfo struct { 164 CommonFieldList []UserInfoCommonField `json:"common_field_list,omitempty"` 165 CustomFieldList []UserInfoCustomField `json:"custom_field_list,omitempty"` 166} 167 168type DateInfo struct { 169 Type *DateType `json:"type,omitempty"` 170 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 171 AvailableEndTime *string `json:"available_end_time,omitempty"` 172 AvailableDayAfterReceive *int64 `json:"available_day_after_receive,omitempty"` 173} 174 175type CardType string 176 177func (e CardType) Ptr() *CardType { 178 return &e 179} 180 181const ( 182 CARDTYPE_PURCHASE CardType = "PURCHASE" 183 CARDTYPE_NORMAL CardType = "NORMAL" 184 CARDTYPE_BALANCE CardType = "BALANCE" 185) 186 187type UserCardState string 188 189func (e UserCardState) Ptr() *UserCardState { 190 return &e 191} 192 193const ( 194 USERCARDSTATE_UNACTIVATED UserCardState = "UNACTIVATED" 195 USERCARDSTATE_EFFECTIVE UserCardState = "EFFECTIVE" 196 USERCARDSTATE_EXPIRED UserCardState = "EXPIRED" 197 USERCARDSTATE_INVALID UserCardState = "INVALID" 198) 199 200type UserInfoCommonField struct { 201 Name *CommonFieldFlag `json:"name,omitempty"` 202 Value *string `json:"value,omitempty"` 203} 204 205type UserInfoCustomField struct { 206 Name *string `json:"name,omitempty"` 207 UserChosenValues []string `json:"user_chosen_values,omitempty"` 208} 209 210type DateType string 211 212func (e DateType) Ptr() *DateType { 213 return &e 214} 215 216const ( 217 DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE" 218 DATETYPE_FIX_TERM DateType = "FIX_TERM" 219 DATETYPE_PERMANENT DateType = "PERMANENT" 220) 221 222type CommonFieldFlag string 223 224func (e CommonFieldFlag) Ptr() *CommonFieldFlag { 225 return &e 226} 227 228const ( 229 COMMONFIELDFLAG_USER_FORM_FLAG_SEX CommonFieldFlag = "USER_FORM_FLAG_SEX" 230 COMMONFIELDFLAG_USER_FORM_FLAG_NAME CommonFieldFlag = "USER_FORM_FLAG_NAME" 231 COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY" 232 COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS CommonFieldFlag = "USER_FORM_FLAG_ADDRESS" 233 COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL CommonFieldFlag = "USER_FORM_FLAG_EMAIL" 234 COMMONFIELDFLAG_USER_FORM_FLAG_CITY CommonFieldFlag = "USER_FORM_FLAG_CITY" 235) 236
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/brand/partner/card-member/user-cards/import-by-phone \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: 5157F09EFDC096DE15EBE81A47057A7232F1B8E1" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "brand_id" : "1004", 9 "card_id" : "pbLatjvWOibDc5-TBnbUk1pD12o0", 10 "phone_number" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==", 11 "user_card_code" : "478515832665", 12 "card_color" : "#FFFF00", 13 "card_picture_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0", 14 "level" : "钻石会员", 15 "user_information" : { 16 "common_field_list" : [ 17 { 18 "name" : "USER_FORM_FLAG_BIRTHDAY", 19 "value" : "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==" 20 } 21 ], 22 "custom_field_list" : [ 23 { 24 "name" : "喜欢的运动", 25 "user_chosen_values" : [ 26 "vvysDQeEaH3I+wRh14St0abIkvQyFgh/fbWYSs2bLtG9tj+bdJn4WSCPzLhShNHgujZzseiL6sYmT7E65mv/eFeTa7yslYfrX0hrhHazSM/+tfvN/C3OZwiBbcrF9LTIIdBVhGOqhCx0gK5YAVZc8dbW/yJqC5i79PDfVYJtpQe3A4v/GiDa2Q+Mv03taxgnEkzqlSPjkXiCYBj9UaFJ4bqCTXiO2Kt6TpczvAaZW+9/blxiJwqEFXe78LbrIQvkDUmVdZbqBdPQ+QGQgc/2Ea4IbP/EEt1qSyXnFbzaaKSE2j4mAFON3kzNexb/SYkHZNJAuCittaW4wpGj7U+h9A==" 27 ] 28 } 29 ] 30 }, 31 "valid_date_information" : { 32 "type" : "PERMANENT", 33 "available_begin_time" : "2020-05-20T13:29:35.120+08:00", 34 "available_end_time" : "2020-05-20T13:29:35.120+08:00", 35 "available_day_after_receive" : 30 36 }, 37 "pickup_time" : "2020-05-20T13:29:35.120+08:00" 38 }' 39
应答参数
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
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 会员卡模版ID不属于该品牌 | 请确认品牌ID和会员卡模版ID是否正确 |
400 | INVALID_REQUEST | 该手机号已被导入过 | 请更换手机号重试 |
400 | INVALID_REQUEST | 手机号未绑定微信号,无法导入 | 请更换手机号重试 |
400 | INVALID_REQUEST | 该手机号或会员卡code已存在 | 请调用修改用户会员卡信息接口 |