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