查询会员卡模板信息
更新时间:2025.06.22通过此接口可查询指定会员卡模板的所有信息
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/brand/partner/card-member/cards/{card_id}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
card_id 必填 string(32)
【会员卡模板 ID】 商家创建微信会员卡模板成功后系统返回的会员卡模板ID
query 查询参数
brand_id 必填 string(32)
【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方
请求示例
需配合微信支付工具库 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 GetCard { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/brand/partner/card-member/cards/{card_id}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 GetCard client = new GetCard( 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 GetCardRequest request = new GetCardRequest(); 41 request.cardId = "pbLatjvWOibDc5-TBnbUk1pD1"; 42 request.brandId = "1004"; 43 try { 44 Card response = client.run(request); 45 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public Card run(GetCardRequest request) { 55 String uri = PATH; 56 uri = uri.replace("{card_id}", WXPayUtility.urlEncode(request.cardId)); 57 Map<String, Object> args = new HashMap<>(); 58 args.put("brand_id", request.brandId); 59 uri = uri + "?" + WXPayUtility.urlEncode(args); 60 61 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 62 reqBuilder.addHeader("Accept", "application/json"); 63 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 64 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 65 reqBuilder.method(METHOD, null); 66 Request httpRequest = reqBuilder.build(); 67 68 // 发送HTTP请求 69 OkHttpClient client = new OkHttpClient.Builder().build(); 70 try (Response httpResponse = client.newCall(httpRequest).execute()) { 71 String respBody = WXPayUtility.extractBody(httpResponse); 72 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 73 // 2XX 成功,验证应答签名 74 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 75 httpResponse.headers(), respBody); 76 77 // 从HTTP应答报文构建返回数据 78 return WXPayUtility.fromJson(respBody, Card.class); 79 } else { 80 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 81 } 82 } catch (IOException e) { 83 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 84 } 85 } 86 87 private final String mchid; 88 private final String certificateSerialNo; 89 private final PrivateKey privateKey; 90 private final String wechatPayPublicKeyId; 91 private final PublicKey wechatPayPublicKey; 92 93 public GetCard(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 94 this.mchid = mchid; 95 this.certificateSerialNo = certificateSerialNo; 96 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 97 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 98 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 99 } 100 101 public static class GetCardRequest { 102 @SerializedName("brand_id") 103 @Expose(serialize = false) 104 public String brandId; 105 106 @SerializedName("card_id") 107 @Expose(serialize = false) 108 public String cardId; 109 } 110 111 public static class Card { 112 @SerializedName("out_request_no") 113 public String outRequestNo; 114 115 @SerializedName("card_id") 116 public String cardId; 117 118 @SerializedName("brand_id") 119 public String brandId; 120 121 @SerializedName("appid") 122 public String appid; 123 124 @SerializedName("card_type") 125 public CardType cardType; 126 127 @SerializedName("card_title") 128 public String cardTitle; 129 130 @SerializedName("card_color") 131 public String cardColor; 132 133 @SerializedName("card_picture_url") 134 public String cardPictureUrl; 135 136 @SerializedName("code_mode") 137 public CodeMode codeMode; 138 139 @SerializedName("code_type") 140 public CodeType codeType; 141 142 @SerializedName("code_jump_information") 143 public CodeJumpInfo codeJumpInformation; 144 145 @SerializedName("benefits") 146 public String benefits; 147 148 @SerializedName("notify_url") 149 public String notifyUrl; 150 151 @SerializedName("need_pinned") 152 public Boolean needPinned; 153 154 @SerializedName("need_display_level") 155 public Boolean needDisplayLevel; 156 157 @SerializedName("init_level") 158 public String initLevel; 159 160 @SerializedName("service_phone") 161 public String servicePhone; 162 163 @SerializedName("legal_agreement") 164 public String legalAgreement; 165 166 @SerializedName("valid_date_information") 167 public DateInfo validDateInformation; 168 169 @SerializedName("member_information") 170 public MemberInfo memberInformation; 171 172 @SerializedName("points_information") 173 public PointsInfo pointsInformation; 174 175 @SerializedName("balance_information") 176 public BalanceInfo balanceInformation; 177 178 @SerializedName("purchase_information") 179 public PurchaseInfo purchaseInformation; 180 181 @SerializedName("user_information") 182 public UserInfoForm userInformation; 183 184 @SerializedName("state") 185 public CardState state; 186 187 @SerializedName("create_time") 188 public String createTime; 189 190 @SerializedName("modify_time") 191 public String modifyTime; 192 } 193 194 public enum CardType { 195 @SerializedName("PURCHASE") 196 PURCHASE, 197 @SerializedName("NORMAL") 198 NORMAL, 199 @SerializedName("BALANCE") 200 BALANCE 201 } 202 203 public enum CodeMode { 204 @SerializedName("SYSTEM_ALLOCATE") 205 SYSTEM_ALLOCATE, 206 @SerializedName("MERCHANT_ALLOCATE") 207 MERCHANT_ALLOCATE 208 } 209 210 public enum CodeType { 211 @SerializedName("NONE_CODE") 212 NONE_CODE, 213 @SerializedName("BAR_CODE") 214 BAR_CODE, 215 @SerializedName("QR_CODE") 216 QR_CODE, 217 @SerializedName("BAR_CODE_AND_QR_CODE") 218 BAR_CODE_AND_QR_CODE, 219 @SerializedName("JUMP_MINI_PROGRAM") 220 JUMP_MINI_PROGRAM 221 } 222 223 public static class CodeJumpInfo { 224 @SerializedName("jump_appid") 225 public String jumpAppid; 226 227 @SerializedName("jump_path") 228 public String jumpPath; 229 } 230 231 public static class DateInfo { 232 @SerializedName("type") 233 public DateType type; 234 235 @SerializedName("available_begin_time") 236 public String availableBeginTime; 237 238 @SerializedName("available_end_time") 239 public String availableEndTime; 240 241 @SerializedName("available_day_after_receive") 242 public Long availableDayAfterReceive; 243 } 244 245 public static class MemberInfo { 246 @SerializedName("jump_appid") 247 public String jumpAppid; 248 249 @SerializedName("jump_path") 250 public String jumpPath; 251 } 252 253 public static class PointsInfo { 254 @SerializedName("jump_appid") 255 public String jumpAppid; 256 257 @SerializedName("jump_path") 258 public String jumpPath; 259 } 260 261 public static class BalanceInfo { 262 @SerializedName("jump_appid") 263 public String jumpAppid; 264 265 @SerializedName("jump_path") 266 public String jumpPath; 267 } 268 269 public static class PurchaseInfo { 270 @SerializedName("price") 271 public Long price; 272 273 @SerializedName("jump_appid") 274 public String jumpAppid; 275 276 @SerializedName("jump_path") 277 public String jumpPath; 278 } 279 280 public static class UserInfoForm { 281 @SerializedName("common_field_list") 282 public List<CommonFieldFlag> commonFieldList; 283 284 @SerializedName("custom_field_list") 285 public List<UserCustomFieldForm> customFieldList; 286 } 287 288 public enum CardState { 289 @SerializedName("CARD_EFFECTIVE") 290 CARD_EFFECTIVE, 291 @SerializedName("CARD_INVALID") 292 CARD_INVALID 293 } 294 295 public enum DateType { 296 @SerializedName("FIX_TIME_RANGE") 297 FIX_TIME_RANGE, 298 @SerializedName("FIX_TERM") 299 FIX_TERM, 300 @SerializedName("PERMANENT") 301 PERMANENT 302 } 303 304 public enum CommonFieldFlag { 305 @SerializedName("USER_FORM_FLAG_SEX") 306 USER_FORM_FLAG_SEX, 307 @SerializedName("USER_FORM_FLAG_NAME") 308 USER_FORM_FLAG_NAME, 309 @SerializedName("USER_FORM_FLAG_BIRTHDAY") 310 USER_FORM_FLAG_BIRTHDAY, 311 @SerializedName("USER_FORM_FLAG_ADDRESS") 312 USER_FORM_FLAG_ADDRESS, 313 @SerializedName("USER_FORM_FLAG_EMAIL") 314 USER_FORM_FLAG_EMAIL, 315 @SerializedName("USER_FORM_FLAG_CITY") 316 USER_FORM_FLAG_CITY 317 } 318 319 public static class UserCustomFieldForm { 320 @SerializedName("type") 321 public CustomFieldType type; 322 323 @SerializedName("name") 324 public String name; 325 326 @SerializedName("values") 327 public List<String> values; 328 } 329 330 public enum CustomFieldType { 331 @SerializedName("CHECK_BOX") 332 CHECK_BOX, 333 @SerializedName("RADIO") 334 RADIO 335 } 336 337} 338
需配合微信支付工具库 wxpay_utility 使用,请参考 Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "strings" 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 := &GetCardRequest{ 27 BrandId: wxpay_utility.String("1004"), 28 CardId: wxpay_utility.String("pbLatjvWOibDc5-TBnbUk1pD1"), 29 } 30 31 response, err := GetCard(config, request) 32 if err != nil { 33 fmt.Printf("请求失败: %+v\n", err) 34 // TODO: 请求失败,根据状态码执行不同的处理 35 return 36 } 37 38 // TODO: 请求成功,继续业务逻辑 39 fmt.Printf("请求成功: %+v\n", response) 40} 41 42func GetCard(config *wxpay_utility.MchConfig, request *GetCardRequest) (response *Card, err error) { 43 const ( 44 host = "https://api.mch.weixin.qq.com" 45 method = "GET" 46 path = "/v3/brand/partner/card-member/cards/{card_id}" 47 ) 48 49 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 50 if err != nil { 51 return nil, err 52 } 53 reqUrl.Path = strings.Replace(reqUrl.Path, "{card_id}", url.PathEscape(*request.CardId), -1) 54 query := reqUrl.Query() 55 query.Add("brand_id", *request.BrandId) 56 reqUrl.RawQuery = query.Encode() 57 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 58 if err != nil { 59 return nil, err 60 } 61 httpRequest.Header.Set("Accept", "application/json") 62 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 63 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Authorization", authorization) 68 69 client := &http.Client{} 70 httpResponse, err := client.Do(httpRequest) 71 if err != nil { 72 return nil, err 73 } 74 75 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 76 if err != nil { 77 return nil, err 78 } 79 80 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 81 // 2XX 成功,验证应答签名 82 err = wxpay_utility.ValidateResponse( 83 config.WechatPayPublicKeyId(), 84 config.WechatPayPublicKey(), 85 &httpResponse.Header, 86 respBody, 87 ) 88 if err != nil { 89 return nil, err 90 } 91 92 if err := json.Unmarshal(respBody, response); err != nil { 93 return nil, err 94 } 95 96 return response, nil 97 } else { 98 return nil, wxpay_utility.NewApiException( 99 httpResponse.StatusCode, 100 httpResponse.Header, 101 respBody, 102 ) 103 } 104} 105 106type GetCardRequest struct { 107 BrandId *string `json:"brand_id,omitempty"` 108 CardId *string `json:"card_id,omitempty"` 109} 110 111func (o *GetCardRequest) MarshalJSON() ([]byte, error) { 112 type Alias GetCardRequest 113 a := &struct { 114 BrandId *string `json:"brand_id,omitempty"` 115 CardId *string `json:"card_id,omitempty"` 116 *Alias 117 }{ 118 // 序列化时移除非 Body 字段 119 BrandId: nil, 120 CardId: nil, 121 Alias: (*Alias)(o), 122 } 123 return json.Marshal(a) 124} 125 126type Card struct { 127 OutRequestNo *string `json:"out_request_no,omitempty"` 128 CardId *string `json:"card_id,omitempty"` 129 BrandId *string `json:"brand_id,omitempty"` 130 Appid *string `json:"appid,omitempty"` 131 CardType *CardType `json:"card_type,omitempty"` 132 CardTitle *string `json:"card_title,omitempty"` 133 CardColor *string `json:"card_color,omitempty"` 134 CardPictureUrl *string `json:"card_picture_url,omitempty"` 135 CodeMode *CodeMode `json:"code_mode,omitempty"` 136 CodeType *CodeType `json:"code_type,omitempty"` 137 CodeJumpInformation *CodeJumpInfo `json:"code_jump_information,omitempty"` 138 Benefits *string `json:"benefits,omitempty"` 139 NotifyUrl *string `json:"notify_url,omitempty"` 140 NeedPinned *bool `json:"need_pinned,omitempty"` 141 NeedDisplayLevel *bool `json:"need_display_level,omitempty"` 142 InitLevel *string `json:"init_level,omitempty"` 143 ServicePhone *string `json:"service_phone,omitempty"` 144 LegalAgreement *string `json:"legal_agreement,omitempty"` 145 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 146 MemberInformation *MemberInfo `json:"member_information,omitempty"` 147 PointsInformation *PointsInfo `json:"points_information,omitempty"` 148 BalanceInformation *BalanceInfo `json:"balance_information,omitempty"` 149 PurchaseInformation *PurchaseInfo `json:"purchase_information,omitempty"` 150 UserInformation *UserInfoForm `json:"user_information,omitempty"` 151 State *CardState `json:"state,omitempty"` 152 CreateTime *string `json:"create_time,omitempty"` 153 ModifyTime *string `json:"modify_time,omitempty"` 154} 155 156type CardType string 157 158func (e CardType) Ptr() *CardType { 159 return &e 160} 161 162const ( 163 CARDTYPE_PURCHASE CardType = "PURCHASE" 164 CARDTYPE_NORMAL CardType = "NORMAL" 165 CARDTYPE_BALANCE CardType = "BALANCE" 166) 167 168type CodeMode string 169 170func (e CodeMode) Ptr() *CodeMode { 171 return &e 172} 173 174const ( 175 CODEMODE_SYSTEM_ALLOCATE CodeMode = "SYSTEM_ALLOCATE" 176 CODEMODE_MERCHANT_ALLOCATE CodeMode = "MERCHANT_ALLOCATE" 177) 178 179type CodeType string 180 181func (e CodeType) Ptr() *CodeType { 182 return &e 183} 184 185const ( 186 CODETYPE_NONE_CODE CodeType = "NONE_CODE" 187 CODETYPE_BAR_CODE CodeType = "BAR_CODE" 188 CODETYPE_QR_CODE CodeType = "QR_CODE" 189 CODETYPE_BAR_CODE_AND_QR_CODE CodeType = "BAR_CODE_AND_QR_CODE" 190 CODETYPE_JUMP_MINI_PROGRAM CodeType = "JUMP_MINI_PROGRAM" 191) 192 193type CodeJumpInfo struct { 194 JumpAppid *string `json:"jump_appid,omitempty"` 195 JumpPath *string `json:"jump_path,omitempty"` 196} 197 198type DateInfo struct { 199 Type *DateType `json:"type,omitempty"` 200 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 201 AvailableEndTime *string `json:"available_end_time,omitempty"` 202 AvailableDayAfterReceive *int64 `json:"available_day_after_receive,omitempty"` 203} 204 205type MemberInfo struct { 206 JumpAppid *string `json:"jump_appid,omitempty"` 207 JumpPath *string `json:"jump_path,omitempty"` 208} 209 210type PointsInfo struct { 211 JumpAppid *string `json:"jump_appid,omitempty"` 212 JumpPath *string `json:"jump_path,omitempty"` 213} 214 215type BalanceInfo struct { 216 JumpAppid *string `json:"jump_appid,omitempty"` 217 JumpPath *string `json:"jump_path,omitempty"` 218} 219 220type PurchaseInfo struct { 221 Price *int64 `json:"price,omitempty"` 222 JumpAppid *string `json:"jump_appid,omitempty"` 223 JumpPath *string `json:"jump_path,omitempty"` 224} 225 226type UserInfoForm struct { 227 CommonFieldList []CommonFieldFlag `json:"common_field_list,omitempty"` 228 CustomFieldList []UserCustomFieldForm `json:"custom_field_list,omitempty"` 229} 230 231type CardState string 232 233func (e CardState) Ptr() *CardState { 234 return &e 235} 236 237const ( 238 CARDSTATE_CARD_EFFECTIVE CardState = "CARD_EFFECTIVE" 239 CARDSTATE_CARD_INVALID CardState = "CARD_INVALID" 240) 241 242type DateType string 243 244func (e DateType) Ptr() *DateType { 245 return &e 246} 247 248const ( 249 DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE" 250 DATETYPE_FIX_TERM DateType = "FIX_TERM" 251 DATETYPE_PERMANENT DateType = "PERMANENT" 252) 253 254type CommonFieldFlag string 255 256func (e CommonFieldFlag) Ptr() *CommonFieldFlag { 257 return &e 258} 259 260const ( 261 COMMONFIELDFLAG_USER_FORM_FLAG_SEX CommonFieldFlag = "USER_FORM_FLAG_SEX" 262 COMMONFIELDFLAG_USER_FORM_FLAG_NAME CommonFieldFlag = "USER_FORM_FLAG_NAME" 263 COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY" 264 COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS CommonFieldFlag = "USER_FORM_FLAG_ADDRESS" 265 COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL CommonFieldFlag = "USER_FORM_FLAG_EMAIL" 266 COMMONFIELDFLAG_USER_FORM_FLAG_CITY CommonFieldFlag = "USER_FORM_FLAG_CITY" 267) 268 269type UserCustomFieldForm struct { 270 Type *CustomFieldType `json:"type,omitempty"` 271 Name *string `json:"name,omitempty"` 272 Values []string `json:"values,omitempty"` 273} 274 275type CustomFieldType string 276 277func (e CustomFieldType) Ptr() *CustomFieldType { 278 return &e 279} 280 281const ( 282 CUSTOMFIELDTYPE_CHECK_BOX CustomFieldType = "CHECK_BOX" 283 CUSTOMFIELDTYPE_RADIO CustomFieldType = "RADIO" 284) 285
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/brand/partner/card-member/cards/pbLatjvWOibDc5-TBnbUk1pD1?brand_id=1004 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
应答参数
200 OK
out_request_no 必填 string(128)
【商家请求单号】 商家创建会员卡模板凭据号。商家自定义,注意保持唯一性,仅供参考的格式:品牌ID+时间戳+流水号。字符仅允许包含英文半角的数字、字母、连接线-
和下划线_
。
card_id 必填 string(32)
【会员卡模板 ID】 商家创建微信会员卡模板成功后系统返回的会员卡模板ID
brand_id 必填 string(32)
【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方
appid 必填 string
【商家AppID】 商家的AppID,可以是服务号、订阅号、公众号、小程序的AppID。1、该AppID用于获取会员OpenID。2、该AppID需要与会员卡归属品牌有B-A关系。
card_type 必填 string
【会员卡类型】 支持付费、普通、储值 3 种类型。
可选取值
PURCHASE
: 付费NORMAL
: 普通BALANCE
: 储值
card_title 必填 string(10)
【卡名称】 1.可用于展示在卡面的名称 2.支持最长10个中文字 3.支持中文字、英文字符、标点
card_color 必填 string(7)
【卡背景颜色】 用于卡片正面设计的RGB颜色编码,仅支持十六进制
card_picture_url 必填 string(256)
【卡图片】 商家自定义会员卡背景图。仅支持通过图片上传API接口获取的图片URL地址。支持JPG/JPEG/PNG格式,建议尺寸716px*320px,且图片小于1M。查看以下链接后传入:图片要求示例,图片上传API指引。
code_mode 必填 string
【会员卡code分配类型】 1、会员卡code是会员在一个会员卡模版下唯一身份标识,平台支持2种分配类型:(1)SYSTEM_ALLOCATE 微信支付系统分配,用户领取会员卡时从微信系统分配12位数字作为会员code;(2)MERCHANT_ALLOCATE 商家预存code,商家可提前通过导入预存code接口导入code,用户领取会员卡时平台从商家导入的code中随机分配作为会员code 2、会员卡code分配模式若为“系统分配”,不支持修改为“商家分配”。
可选取值
SYSTEM_ALLOCATE
: 系统分配MERCHANT_ALLOCATE
: 商家分配
code_type 必填 string
【会员码型】 会员码支持不展示码/二维码/条形码/二维码+条形码/跳转商家小程序5种设置。
可选取值
NONE_CODE
: 不显示任何码型BAR_CODE
: 条形码QR_CODE
: 二维码BAR_CODE_AND_QR_CODE
: 条形码和二维码JUMP_MINI_PROGRAM
: 跳转商家小程序
code_jump_information 选填 object
【会员码跳转信息】 会员码跳转的小程序信息,当会员码型为跳转商家小程序时必填。
属性 | |
jump_appid 选填 string(32) 【会员码跳转AppID】 会员码跳转的小程序AppID jump_path 选填 string(128) 【会员码跳转路径】 会员码跳转的小程序路径 |
benefits 必填 string(32)
【会员权益】 会员权益是指平台、品牌或服务机构为付费会员(或等级会员)提供的专属优惠、服务或特权。
notify_url 必填 string(256)
【回调地址】 商家接收开卡成功回调通知的地址,需按照notify_url填写注意事项规范填写。
need_pinned 选填 boolean
【是否置顶】 置顶卡是界面中的一种特殊展示模块,通过人工设置,使其固定在内容列表的顶部位置,确保用户优先看到。默认为false。同一个品牌下允许存在多张置顶卡,按照更新时间倒序排序。
need_display_level 选填 boolean
【是否展示会员等级】 是否在会员卡面向用户展示等级信息,默认不展示(false)
init_level 选填 string(10)
【会员初始等级】 展示字段,商家可以自定义填写内容。如果选择了展示会员等级,必填init_level
,作为新用户开卡后的初始等级。如因商家业务规则需要变更某会员等级,可通过更新用户会员卡接口更新等级信息。
service_phone 选填 string(32)
【服务电话】 展示在会员卡详情内,建议填写商家固定电话
legal_agreement 选填 string(2048)
【商家法务协议】 商家法务协议是用户与商家之间签订的具有法律效力的合同文件,旨在明确双方在交易、服务提供、权利义务等方面的规则,以保障交易安全、规范商业行为,并在纠纷发生时提供法律依据。
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 天) |
member_information 必填 object
【会员中心信息】 用户点击会员卡卡面的跳转信息
属性 | |
jump_appid 选填 string(32) 【会员中心跳转AppID】 用户点击会员卡卡面后跳转的小程序AppID jump_path 选填 string(128) 【会员中心跳转路径】 用户点击会员卡卡面后跳转的小程序路径 |
points_information 选填 object
【积分信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。
属性 | |
jump_appid 选填 string(32) 【积分跳转AppID】 会员积分跳转的小程序AppID jump_path 选填 string(128) 【积分跳转路径】 会员积分跳转的小程序路径 |
balance_information 选填 object
【储值信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息。否则不启动该功能。
属性 | |
jump_appid 选填 string(32) 【储值小程序AppID】 点击储值额跳转的小程序AppID jump_path 选填 string(128) 【储值小程序路径】 点击储值额跳转的小程序页面路径,建议为储值充值页面 |
purchase_information 选填 object
【付费会员信息】 若商家名片会员卡使用该功能,需传入跳转商家小程序的信息及会员价格。否则不启动该功能。
属性 | |
price 选填 integer 【付费会员价格】 指用户为获取特定商家提供的会员权益而需支付的费用金额。(单位:分) jump_appid 选填 string(32) 【付费会员跳转AppID】 用户购买付费会员时跳转的付费会员的AppID jump_path 选填 string(128) 【付费会员跳转路径】 用户购买付费会员时购买跳转的路径 |
user_information 选填 object
【用户开卡信息】 设置用户在开通会员卡时必须填写的信息
属性 | |||||
common_field_list 选填 array[string] 【平台提供的通用开卡信息字段】 平台提供的通用开卡信息字段。若商户在会员卡模板中设置该值,则查询结果中会返回给商户。 可选取值
custom_field_list 选填 array[object] 【商家自定义的开卡信息字段】 商家自定义的开卡信息字段。若商户在会员卡模板中设置该值,则查询结果中会返回给商户。当前最多只允许传入1项。
|
state 必填 string
【状态】 会员卡状态信息
可选取值
CARD_EFFECTIVE
: 生效中CARD_INVALID
: 已失效
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 "out_request_no" : "100002322019090134234sfdf", 3 "card_id" : "pbLatjvWOibDc5-TBnbUk1pD12o0", 4 "brand_id" : "1004", 5 "appid" : "wxea9c30890f48d5ae", 6 "card_type" : "NORMAL", 7 "card_title" : "测试卡", 8 "card_color" : "#FFFF00", 9 "card_picture_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/0", 10 "code_mode" : "SYSTEM_ALLOCATE", 11 "code_type" : "BAR_CODE", 12 "code_jump_information" : { 13 "jump_appid" : "wxea9c30a90fs8d3fe", 14 "jump_path" : "/pages/code/code" 15 }, 16 "benefits" : "会员折扣、专属价", 17 "notify_url" : "https://www.weixin.qq.com/wxpay/notify.php", 18 "need_pinned" : true, 19 "need_display_level" : true, 20 "init_level" : "白银会员", 21 "service_phone" : "010-8877xxxx", 22 "legal_agreement" : "商家需在 48 小时内发货,若商品存在质量问题,用户可在 7 天内申请退货。", 23 "valid_date_information" : { 24 "type" : "PERMANENT", 25 "available_begin_time" : "2020-05-20T13:29:35.120+08:00", 26 "available_end_time" : "2020-05-20T13:29:35.120+08:00", 27 "available_day_after_receive" : 30 28 }, 29 "member_information" : { 30 "jump_appid" : "wxea9c30a90fs8d3fe", 31 "jump_path" : "/pages/points/points" 32 }, 33 "points_information" : { 34 "jump_appid" : "wxea9c30a90fs8d3fe", 35 "jump_path" : "/pages/points/points" 36 }, 37 "balance_information" : { 38 "jump_appid" : "wxea9c30a90fs8d3fe", 39 "jump_path" : "/pages/balance/balance" 40 }, 41 "purchase_information" : { 42 "price" : 100, 43 "jump_appid" : "wxea9c30a90fs8d3fe", 44 "jump_path" : "/pages/purchase/purchase" 45 }, 46 "user_information" : { 47 "common_field_list" : [ 48 "USER_FORM_FLAG_SEX" 49 ], 50 "custom_field_list" : [ 51 { 52 "type" : "CHECK_BOX", 53 "name" : "喜欢的运动", 54 "values" : [ 55 "篮球" 56 ] 57 } 58 ] 59 }, 60 "state" : "CARD_EFFECTIVE", 61 "create_time" : "2020-05-20T13:29:35.120+08:00", 62 "modify_time" : "2020-05-20T13:29:35.120+08:00" 63} 64
错误码
公共错误码