作废用户会员卡
更新时间:2025.06.22将用户的会员卡设置为作废状态。
注意:1.设置卡券作废的操作不可逆,即无法将设置为作废的卡调回有效状态,商家须慎重调用该接口。
2.商家调用作废接口前须与顾客事先告知并取得同意,否则因此带来的顾客投诉,微信将会按照《微信运营处罚规则》
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/brand/partner/card-member/user-cards/{user_card_code}/invalidate
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
path 路径参数
user_card_code 必填 string(32)
【会员卡code】 会员在一个会员卡模版下的唯一标志,用户领取会员卡后获得的code
query 查询参数
brand_id 必填 string(32)
【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方
card_id 必填 string(32)
【会员卡模板 ID】 商家创建微信会员卡模板成功后系统返回的会员卡模板ID
body 包体参数
openid 必填 string(128)
【用户标识】 用户在品牌商家会员卡模板AppID下的唯一标识
invalid_reason 选填 string(32)
【作废原因】 会员卡作废原因
请求示例
需配合微信支付工具库 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 InvalidateUserCard { 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/{user_card_code}/invalidate"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 InvalidateUserCard client = new InvalidateUserCard( 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 InvalidateUserCardRequest request = new InvalidateUserCardRequest(); 41 request.userCardCode = "478515832665"; 42 request.brandId = "1004"; 43 request.cardId = "pbLatjvWOibDc5-TBnbUk1pD12o0"; 44 request.openid = "obLatjnx9gnqzS4myYGmLZ7LgLBA"; 45 request.invalidReason = "传入的自定义作废原因"; 46 try { 47 UserCard response = client.run(request); 48 49 // TODO: 请求成功,继续业务逻辑 50 System.out.println(response); 51 } catch (WXPayUtility.ApiException e) { 52 // TODO: 请求失败,根据状态码执行不同的逻辑 53 e.printStackTrace(); 54 } 55 } 56 57 public UserCard run(InvalidateUserCardRequest request) { 58 String uri = PATH; 59 uri = uri.replace("{user_card_code}", WXPayUtility.urlEncode(request.userCardCode)); 60 Map<String, Object> args = new HashMap<>(); 61 args.put("brand_id", request.brandId); 62 args.put("card_id", request.cardId); 63 uri = uri + "?" + WXPayUtility.urlEncode(args); 64 String reqBody = WXPayUtility.toJson(request); 65 66 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 67 reqBuilder.addHeader("Accept", "application/json"); 68 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 69 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 70 reqBuilder.addHeader("Content-Type", "application/json"); 71 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 72 reqBuilder.method(METHOD, requestBody); 73 Request httpRequest = reqBuilder.build(); 74 75 // 发送HTTP请求 76 OkHttpClient client = new OkHttpClient.Builder().build(); 77 try (Response httpResponse = client.newCall(httpRequest).execute()) { 78 String respBody = WXPayUtility.extractBody(httpResponse); 79 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 80 // 2XX 成功,验证应答签名 81 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 82 httpResponse.headers(), respBody); 83 84 // 从HTTP应答报文构建返回数据 85 return WXPayUtility.fromJson(respBody, UserCard.class); 86 } else { 87 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 88 } 89 } catch (IOException e) { 90 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 91 } 92 } 93 94 private final String mchid; 95 private final String certificateSerialNo; 96 private final PrivateKey privateKey; 97 private final String wechatPayPublicKeyId; 98 private final PublicKey wechatPayPublicKey; 99 100 public InvalidateUserCard(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 101 this.mchid = mchid; 102 this.certificateSerialNo = certificateSerialNo; 103 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 104 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 105 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 106 } 107 108 public static class InvalidateUserCardRequest { 109 @SerializedName("brand_id") 110 @Expose(serialize = false) 111 public String brandId; 112 113 @SerializedName("card_id") 114 @Expose(serialize = false) 115 public String cardId; 116 117 @SerializedName("user_card_code") 118 @Expose(serialize = false) 119 public String userCardCode; 120 121 @SerializedName("openid") 122 public String openid; 123 124 @SerializedName("invalid_reason") 125 public String invalidReason; 126 } 127 128 public static class UserCard { 129 @SerializedName("user_card_code") 130 public String userCardCode; 131 132 @SerializedName("card_id") 133 public String cardId; 134 135 @SerializedName("openid") 136 public String openid; 137 138 @SerializedName("card_color") 139 public String cardColor; 140 141 @SerializedName("card_picture_url") 142 public String cardPictureUrl; 143 144 @SerializedName("brand_id") 145 public String brandId; 146 147 @SerializedName("card_type") 148 public CardType cardType; 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("pickup_time") 160 public String pickupTime; 161 162 @SerializedName("user_information") 163 public UserInfo userInformation; 164 165 @SerializedName("attach") 166 public String attach; 167 168 @SerializedName("user_card_state") 169 public UserCardState userCardState; 170 171 @SerializedName("invalid_reason") 172 public String invalidReason; 173 174 @SerializedName("invalid_time") 175 public String invalidTime; 176 177 @SerializedName("create_time") 178 public String createTime; 179 180 @SerializedName("modify_time") 181 public String modifyTime; 182 } 183 184 public enum CardType { 185 @SerializedName("PURCHASE") 186 PURCHASE, 187 @SerializedName("NORMAL") 188 NORMAL, 189 @SerializedName("BALANCE") 190 BALANCE 191 } 192 193 public static class DateInfo { 194 @SerializedName("type") 195 public DateType type; 196 197 @SerializedName("available_begin_time") 198 public String availableBeginTime; 199 200 @SerializedName("available_end_time") 201 public String availableEndTime; 202 203 @SerializedName("available_day_after_receive") 204 public Long availableDayAfterReceive; 205 } 206 207 public static class UserInfo { 208 @SerializedName("common_field_list") 209 public List<UserInfoCommonField> commonFieldList; 210 211 @SerializedName("custom_field_list") 212 public List<UserInfoCustomField> customFieldList; 213 } 214 215 public enum UserCardState { 216 @SerializedName("UNACTIVATED") 217 UNACTIVATED, 218 @SerializedName("EFFECTIVE") 219 EFFECTIVE, 220 @SerializedName("EXPIRED") 221 EXPIRED, 222 @SerializedName("INVALID") 223 INVALID 224 } 225 226 public enum DateType { 227 @SerializedName("FIX_TIME_RANGE") 228 FIX_TIME_RANGE, 229 @SerializedName("FIX_TERM") 230 FIX_TERM, 231 @SerializedName("PERMANENT") 232 PERMANENT 233 } 234 235 public static class UserInfoCommonField { 236 @SerializedName("name") 237 public CommonFieldFlag name; 238 239 @SerializedName("value") 240 public String value; 241 } 242 243 public static class UserInfoCustomField { 244 @SerializedName("name") 245 public String name; 246 247 @SerializedName("user_chosen_values") 248 public List<String> userChosenValues; 249 } 250 251 public enum CommonFieldFlag { 252 @SerializedName("USER_FORM_FLAG_SEX") 253 USER_FORM_FLAG_SEX, 254 @SerializedName("USER_FORM_FLAG_NAME") 255 USER_FORM_FLAG_NAME, 256 @SerializedName("USER_FORM_FLAG_BIRTHDAY") 257 USER_FORM_FLAG_BIRTHDAY, 258 @SerializedName("USER_FORM_FLAG_ADDRESS") 259 USER_FORM_FLAG_ADDRESS, 260 @SerializedName("USER_FORM_FLAG_EMAIL") 261 USER_FORM_FLAG_EMAIL, 262 @SerializedName("USER_FORM_FLAG_CITY") 263 USER_FORM_FLAG_CITY 264 } 265 266} 267
需配合微信支付工具库 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 "strings" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &InvalidateUserCardRequest{ 28 BrandId: wxpay_utility.String("1004"), 29 CardId: wxpay_utility.String("pbLatjvWOibDc5-TBnbUk1pD12o0"), 30 UserCardCode: wxpay_utility.String("478515832665"), 31 Openid: wxpay_utility.String("obLatjnx9gnqzS4myYGmLZ7LgLBA"), 32 InvalidReason: wxpay_utility.String("传入的自定义作废原因"), 33 } 34 35 response, err := InvalidateUserCard(config, request) 36 if err != nil { 37 fmt.Printf("请求失败: %+v\n", err) 38 // TODO: 请求失败,根据状态码执行不同的处理 39 return 40 } 41 42 // TODO: 请求成功,继续业务逻辑 43 fmt.Printf("请求成功: %+v\n", response) 44} 45 46func InvalidateUserCard(config *wxpay_utility.MchConfig, request *InvalidateUserCardRequest) (response *UserCard, err error) { 47 const ( 48 host = "https://api.mch.weixin.qq.com" 49 method = "POST" 50 path = "/v3/brand/partner/card-member/user-cards/{user_card_code}/invalidate" 51 ) 52 53 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 54 if err != nil { 55 return nil, err 56 } 57 reqUrl.Path = strings.Replace(reqUrl.Path, "{user_card_code}", url.PathEscape(*request.UserCardCode), -1) 58 query := reqUrl.Query() 59 query.Add("brand_id", *request.BrandId) 60 query.Add("card_id", *request.CardId) 61 reqUrl.RawQuery = query.Encode() 62 reqBody, err := json.Marshal(request) 63 if err != nil { 64 return nil, err 65 } 66 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 67 if err != nil { 68 return nil, err 69 } 70 httpRequest.Header.Set("Accept", "application/json") 71 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 72 httpRequest.Header.Set("Content-Type", "application/json") 73 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 74 if err != nil { 75 return nil, err 76 } 77 httpRequest.Header.Set("Authorization", authorization) 78 79 client := &http.Client{} 80 httpResponse, err := client.Do(httpRequest) 81 if err != nil { 82 return nil, err 83 } 84 85 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 86 if err != nil { 87 return nil, err 88 } 89 90 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 91 // 2XX 成功,验证应答签名 92 err = wxpay_utility.ValidateResponse( 93 config.WechatPayPublicKeyId(), 94 config.WechatPayPublicKey(), 95 &httpResponse.Header, 96 respBody, 97 ) 98 if err != nil { 99 return nil, err 100 } 101 102 if err := json.Unmarshal(respBody, response); err != nil { 103 return nil, err 104 } 105 106 return response, nil 107 } else { 108 return nil, wxpay_utility.NewApiException( 109 httpResponse.StatusCode, 110 httpResponse.Header, 111 respBody, 112 ) 113 } 114} 115 116type InvalidateUserCardRequest struct { 117 BrandId *string `json:"brand_id,omitempty"` 118 CardId *string `json:"card_id,omitempty"` 119 UserCardCode *string `json:"user_card_code,omitempty"` 120 Openid *string `json:"openid,omitempty"` 121 InvalidReason *string `json:"invalid_reason,omitempty"` 122} 123 124func (o *InvalidateUserCardRequest) MarshalJSON() ([]byte, error) { 125 type Alias InvalidateUserCardRequest 126 a := &struct { 127 BrandId *string `json:"brand_id,omitempty"` 128 CardId *string `json:"card_id,omitempty"` 129 UserCardCode *string `json:"user_card_code,omitempty"` 130 *Alias 131 }{ 132 // 序列化时移除非 Body 字段 133 BrandId: nil, 134 CardId: nil, 135 UserCardCode: nil, 136 Alias: (*Alias)(o), 137 } 138 return json.Marshal(a) 139} 140 141type UserCard struct { 142 UserCardCode *string `json:"user_card_code,omitempty"` 143 CardId *string `json:"card_id,omitempty"` 144 Openid *string `json:"openid,omitempty"` 145 CardColor *string `json:"card_color,omitempty"` 146 CardPictureUrl *string `json:"card_picture_url,omitempty"` 147 BrandId *string `json:"brand_id,omitempty"` 148 CardType *CardType `json:"card_type,omitempty"` 149 PhoneNumber *string `json:"phone_number,omitempty"` 150 Level *string `json:"level,omitempty"` 151 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 152 PickupTime *string `json:"pickup_time,omitempty"` 153 UserInformation *UserInfo `json:"user_information,omitempty"` 154 Attach *string `json:"attach,omitempty"` 155 UserCardState *UserCardState `json:"user_card_state,omitempty"` 156 InvalidReason *string `json:"invalid_reason,omitempty"` 157 InvalidTime *string `json:"invalid_time,omitempty"` 158 CreateTime *string `json:"create_time,omitempty"` 159 ModifyTime *string `json:"modify_time,omitempty"` 160} 161 162type CardType string 163 164func (e CardType) Ptr() *CardType { 165 return &e 166} 167 168const ( 169 CARDTYPE_PURCHASE CardType = "PURCHASE" 170 CARDTYPE_NORMAL CardType = "NORMAL" 171 CARDTYPE_BALANCE CardType = "BALANCE" 172) 173 174type DateInfo struct { 175 Type *DateType `json:"type,omitempty"` 176 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 177 AvailableEndTime *string `json:"available_end_time,omitempty"` 178 AvailableDayAfterReceive *int64 `json:"available_day_after_receive,omitempty"` 179} 180 181type UserInfo struct { 182 CommonFieldList []UserInfoCommonField `json:"common_field_list,omitempty"` 183 CustomFieldList []UserInfoCustomField `json:"custom_field_list,omitempty"` 184} 185 186type UserCardState string 187 188func (e UserCardState) Ptr() *UserCardState { 189 return &e 190} 191 192const ( 193 USERCARDSTATE_UNACTIVATED UserCardState = "UNACTIVATED" 194 USERCARDSTATE_EFFECTIVE UserCardState = "EFFECTIVE" 195 USERCARDSTATE_EXPIRED UserCardState = "EXPIRED" 196 USERCARDSTATE_INVALID UserCardState = "INVALID" 197) 198 199type DateType string 200 201func (e DateType) Ptr() *DateType { 202 return &e 203} 204 205const ( 206 DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE" 207 DATETYPE_FIX_TERM DateType = "FIX_TERM" 208 DATETYPE_PERMANENT DateType = "PERMANENT" 209) 210 211type UserInfoCommonField struct { 212 Name *CommonFieldFlag `json:"name,omitempty"` 213 Value *string `json:"value,omitempty"` 214} 215 216type UserInfoCustomField struct { 217 Name *string `json:"name,omitempty"` 218 UserChosenValues []string `json:"user_chosen_values,omitempty"` 219} 220 221type CommonFieldFlag string 222 223func (e CommonFieldFlag) Ptr() *CommonFieldFlag { 224 return &e 225} 226 227const ( 228 COMMONFIELDFLAG_USER_FORM_FLAG_SEX CommonFieldFlag = "USER_FORM_FLAG_SEX" 229 COMMONFIELDFLAG_USER_FORM_FLAG_NAME CommonFieldFlag = "USER_FORM_FLAG_NAME" 230 COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY" 231 COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS CommonFieldFlag = "USER_FORM_FLAG_ADDRESS" 232 COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL CommonFieldFlag = "USER_FORM_FLAG_EMAIL" 233 COMMONFIELDFLAG_USER_FORM_FLAG_CITY CommonFieldFlag = "USER_FORM_FLAG_CITY" 234) 235
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/brand/partner/card-member/user-cards/478515832665/invalidate?brand_id=1004&card_id=pbLatjvWOibDc5-TBnbUk1pD12o0 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "openid" : "obLatjnx9gnqzS4myYGmLZ7LgLBA", 8 "invalid_reason" : "传入的自定义作废原因" 9 }' 10
应答参数
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是否正确 |