查询会员卡模板列表
更新时间:2025.08.01通过此接口可查询指定某品牌的所有会员卡模板列表
接口说明
支持商户:【品牌商户】
请求方式:【GET】/brand/card-member/cards
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
接口限频:100/秒(品牌ID维度)
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
query 查询参数
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/brand/card-member/cards?state=CARD_EFFECTIVE&offset=0&limit=20 \ 3 -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: PUB_KEY_ID_XXXX" 6
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayBrandUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/brand/4015826861 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 查询会员卡模板列表 24 */ 25public class ListCard { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/brand/card-member/cards"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 ListCard client = new ListCard( 33 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 34 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 35 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 ListCardRequest request = new ListCardRequest(); 41 request.state = CardState.CARD_EFFECTIVE; 42 request.offset = 0L; 43 request.limit = 20L; 44 try { 45 ListCardResponse response = client.run(request); 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayBrandUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public ListCardResponse run(ListCardRequest request) { 55 String uri = PATH; 56 Map<String, Object> args = new HashMap<>(); 57 args.put("state", request.state); 58 args.put("offset", request.offset); 59 args.put("limit", request.limit); 60 String queryString = WXPayBrandUtility.urlEncode(args); 61 if (!queryString.isEmpty()) { 62 uri = uri + "?" + queryString; 63 } 64 65 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 66 reqBuilder.addHeader("Accept", "application/json"); 67 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 68 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo, privateKey, METHOD, uri, null)); 69 reqBuilder.method(METHOD, null); 70 Request httpRequest = reqBuilder.build(); 71 72 // 发送HTTP请求 73 OkHttpClient client = new OkHttpClient.Builder().build(); 74 try (Response httpResponse = client.newCall(httpRequest).execute()) { 75 String respBody = WXPayBrandUtility.extractBody(httpResponse); 76 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 77 // 2XX 成功,验证应答签名 78 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 79 httpResponse.headers(), respBody); 80 81 // 从HTTP应答报文构建返回数据 82 return WXPayBrandUtility.fromJson(respBody, ListCardResponse.class); 83 } else { 84 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 85 } 86 } catch (IOException e) { 87 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 88 } 89 } 90 91 private final String brand_id; 92 private final String certificateSerialNo; 93 private final PrivateKey privateKey; 94 private final String wechatPayPublicKeyId; 95 private final PublicKey wechatPayPublicKey; 96 97 public ListCard(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 98 this.brand_id = brand_id; 99 this.certificateSerialNo = certificateSerialNo; 100 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 101 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 102 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 103 } 104 105 public static class ListCardRequest { 106 @SerializedName("offset") 107 @Expose(serialize = false) 108 public Long offset; 109 110 @SerializedName("limit") 111 @Expose(serialize = false) 112 public Long limit; 113 114 @SerializedName("state") 115 @Expose(serialize = false) 116 public CardState state; 117 } 118 119 public static class ListCardResponse { 120 @SerializedName("data") 121 public List<Card> data; 122 123 @SerializedName("total_count") 124 public Long totalCount; 125 126 @SerializedName("offset") 127 public Long offset; 128 129 @SerializedName("limit") 130 public Long limit; 131 } 132 133 public enum CardState { 134 @SerializedName("CARD_EFFECTIVE") 135 CARD_EFFECTIVE, 136 @SerializedName("CARD_INVALID") 137 CARD_INVALID 138 } 139 140 public static class Card { 141 @SerializedName("out_request_no") 142 public String outRequestNo; 143 144 @SerializedName("card_id") 145 public String cardId; 146 147 @SerializedName("brand_id") 148 public String brandId; 149 150 @SerializedName("appid") 151 public String appid; 152 153 @SerializedName("card_type") 154 public CardType cardType; 155 156 @SerializedName("card_title") 157 public String cardTitle; 158 159 @SerializedName("card_color") 160 public String cardColor; 161 162 @SerializedName("card_picture_url") 163 public String cardPictureUrl; 164 165 @SerializedName("code_mode") 166 public CodeMode codeMode; 167 168 @SerializedName("code_type") 169 public CodeType codeType; 170 171 @SerializedName("code_jump_information") 172 public CodeJumpInfo codeJumpInformation; 173 174 @SerializedName("benefits") 175 public String benefits; 176 177 @SerializedName("notify_url") 178 public String notifyUrl; 179 180 @SerializedName("need_pinned") 181 public Boolean needPinned; 182 183 @SerializedName("need_display_level") 184 public Boolean needDisplayLevel; 185 186 @SerializedName("init_level") 187 public String initLevel; 188 189 @SerializedName("service_phone") 190 public String servicePhone; 191 192 @SerializedName("legal_agreement") 193 public String legalAgreement; 194 195 @SerializedName("valid_date_information") 196 public DateInfo validDateInformation; 197 198 @SerializedName("member_information") 199 public MemberInfo memberInformation; 200 201 @SerializedName("points_information") 202 public PointsInfo pointsInformation; 203 204 @SerializedName("balance_information") 205 public BalanceInfo balanceInformation; 206 207 @SerializedName("purchase_information") 208 public PurchaseInfo purchaseInformation; 209 210 @SerializedName("user_information") 211 public UserInfoForm userInformation; 212 213 @SerializedName("state") 214 public CardState state; 215 216 @SerializedName("create_time") 217 public String createTime; 218 219 @SerializedName("modify_time") 220 public String modifyTime; 221 222 @SerializedName("support_user_active_join") 223 public Boolean supportUserActiveJoin; 224 225 @SerializedName("purchase_membership") 226 public Boolean purchaseMembership; 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_brand_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/brand/4015826866 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "time" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 14 config, err := wxpay_brand_utility.CreateBrandConfig( 15 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 16 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 17 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &ListCardRequest{ 27 State: CARDSTATE_CARD_EFFECTIVE.Ptr(), 28 Offset: wxpay_brand_utility.Int64(0), 29 Limit: wxpay_brand_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_brand_utility.BrandConfig, request *ListCardRequest) (response *ListCardResponse, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "GET" 47 path = "/brand/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.State != nil { 56 query.Add("state", fmt.Sprintf("%v", *request.State)) 57 } 58 if request.Offset != nil { 59 query.Add("offset", fmt.Sprintf("%v", *request.Offset)) 60 } 61 if request.Limit != nil { 62 query.Add("limit", fmt.Sprintf("%v", *request.Limit)) 63 } 64 reqUrl.RawQuery = query.Encode() 65 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 66 if err != nil { 67 return nil, err 68 } 69 httpRequest.Header.Set("Accept", "application/json") 70 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 71 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 72 if err != nil { 73 return nil, err 74 } 75 httpRequest.Header.Set("Authorization", authorization) 76 77 client := &http.Client{} 78 httpResponse, err := client.Do(httpRequest) 79 if err != nil { 80 return nil, err 81 } 82 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 83 if err != nil { 84 return nil, err 85 } 86 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 87 // 2XX 成功,验证应答签名 88 err = wxpay_brand_utility.ValidateResponse( 89 config.WechatPayPublicKeyId(), 90 config.WechatPayPublicKey(), 91 &httpResponse.Header, 92 respBody, 93 ) 94 if err != nil { 95 return nil, err 96 } 97 response := &ListCardResponse{} 98 if err := json.Unmarshal(respBody, response); err != nil { 99 return nil, err 100 } 101 102 return response, nil 103 } else { 104 return nil, wxpay_brand_utility.NewApiException( 105 httpResponse.StatusCode, 106 httpResponse.Header, 107 respBody, 108 ) 109 } 110} 111 112type ListCardRequest struct { 113 Offset *int64 `json:"offset,omitempty"` 114 Limit *int64 `json:"limit,omitempty"` 115 State *CardState `json:"state,omitempty"` 116} 117 118func (o *ListCardRequest) MarshalJSON() ([]byte, error) { 119 type Alias ListCardRequest 120 a := &struct { 121 Offset *int64 `json:"offset,omitempty"` 122 Limit *int64 `json:"limit,omitempty"` 123 State *CardState `json:"state,omitempty"` 124 *Alias 125 }{ 126 // 序列化时移除非 Body 字段 127 Offset: nil, 128 Limit: nil, 129 State: nil, 130 Alias: (*Alias)(o), 131 } 132 return json.Marshal(a) 133} 134 135type ListCardResponse struct { 136 Data []Card `json:"data,omitempty"` 137 TotalCount *int64 `json:"total_count,omitempty"` 138 Offset *int64 `json:"offset,omitempty"` 139 Limit *int64 `json:"limit,omitempty"` 140} 141 142type CardState string 143 144func (e CardState) Ptr() *CardState { 145 return &e 146} 147 148const ( 149 CARDSTATE_CARD_EFFECTIVE CardState = "CARD_EFFECTIVE" 150 CARDSTATE_CARD_INVALID CardState = "CARD_INVALID" 151) 152 153type Card struct { 154 OutRequestNo *string `json:"out_request_no,omitempty"` 155 CardId *string `json:"card_id,omitempty"` 156 BrandId *string `json:"brand_id,omitempty"` 157 Appid *string `json:"appid,omitempty"` 158 CardType *CardType `json:"card_type,omitempty"` 159 CardTitle *string `json:"card_title,omitempty"` 160 CardColor *string `json:"card_color,omitempty"` 161 CardPictureUrl *string `json:"card_picture_url,omitempty"` 162 CodeMode *CodeMode `json:"code_mode,omitempty"` 163 CodeType *CodeType `json:"code_type,omitempty"` 164 CodeJumpInformation *CodeJumpInfo `json:"code_jump_information,omitempty"` 165 Benefits *string `json:"benefits,omitempty"` 166 NotifyUrl *string `json:"notify_url,omitempty"` 167 NeedPinned *bool `json:"need_pinned,omitempty"` 168 NeedDisplayLevel *bool `json:"need_display_level,omitempty"` 169 InitLevel *string `json:"init_level,omitempty"` 170 ServicePhone *string `json:"service_phone,omitempty"` 171 LegalAgreement *string `json:"legal_agreement,omitempty"` 172 ValidDateInformation *DateInfo `json:"valid_date_information,omitempty"` 173 MemberInformation *MemberInfo `json:"member_information,omitempty"` 174 PointsInformation *PointsInfo `json:"points_information,omitempty"` 175 BalanceInformation *BalanceInfo `json:"balance_information,omitempty"` 176 PurchaseInformation *PurchaseInfo `json:"purchase_information,omitempty"` 177 UserInformation *UserInfoForm `json:"user_information,omitempty"` 178 State *CardState `json:"state,omitempty"` 179 CreateTime *time.Time `json:"create_time,omitempty"` 180 ModifyTime *time.Time `json:"modify_time,omitempty"` 181 SupportUserActiveJoin *bool `json:"support_user_active_join,omitempty"` 182 PurchaseMembership *bool `json:"purchase_membership,omitempty"` 183} 184 185type CardType string 186 187func (e CardType) Ptr() *CardType { 188 return &e 189} 190 191const ( 192 CARDTYPE_PURCHASE CardType = "PURCHASE" 193 CARDTYPE_NORMAL CardType = "NORMAL" 194 CARDTYPE_BALANCE CardType = "BALANCE" 195) 196 197type CodeMode string 198 199func (e CodeMode) Ptr() *CodeMode { 200 return &e 201} 202 203const ( 204 CODEMODE_SYSTEM_ALLOCATE CodeMode = "SYSTEM_ALLOCATE" 205 CODEMODE_MERCHANT_ALLOCATE CodeMode = "MERCHANT_ALLOCATE" 206) 207 208type CodeType string 209 210func (e CodeType) Ptr() *CodeType { 211 return &e 212} 213 214const ( 215 CODETYPE_NONE_CODE CodeType = "NONE_CODE" 216 CODETYPE_BAR_CODE CodeType = "BAR_CODE" 217 CODETYPE_QR_CODE CodeType = "QR_CODE" 218 CODETYPE_BAR_CODE_AND_QR_CODE CodeType = "BAR_CODE_AND_QR_CODE" 219 CODETYPE_JUMP_MINI_PROGRAM CodeType = "JUMP_MINI_PROGRAM" 220) 221 222type CodeJumpInfo struct { 223 JumpAppid *string `json:"jump_appid,omitempty"` 224 JumpPath *string `json:"jump_path,omitempty"` 225} 226 227type DateInfo struct { 228 Type *DateType `json:"type,omitempty"` 229 AvailableBeginTime *time.Time `json:"available_begin_time,omitempty"` 230 AvailableEndTime *time.Time `json:"available_end_time,omitempty"` 231 AvailableDayAfterReceive *int64 `json:"available_day_after_receive,omitempty"` 232} 233 234type MemberInfo struct { 235 JumpAppid *string `json:"jump_appid,omitempty"` 236 JumpPath *string `json:"jump_path,omitempty"` 237} 238 239type PointsInfo struct { 240 JumpAppid *string `json:"jump_appid,omitempty"` 241 JumpPath *string `json:"jump_path,omitempty"` 242} 243 244type BalanceInfo struct { 245 JumpAppid *string `json:"jump_appid,omitempty"` 246 JumpPath *string `json:"jump_path,omitempty"` 247} 248 249type PurchaseInfo struct { 250 Price *int64 `json:"price,omitempty"` 251 JumpAppid *string `json:"jump_appid,omitempty"` 252 JumpPath *string `json:"jump_path,omitempty"` 253} 254 255type UserInfoForm struct { 256 CommonFieldList []CommonFieldFlag `json:"common_field_list,omitempty"` 257 CustomFieldList []UserCustomFieldForm `json:"custom_field_list,omitempty"` 258} 259 260type DateType string 261 262func (e DateType) Ptr() *DateType { 263 return &e 264} 265 266const ( 267 DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE" 268 DATETYPE_FIX_TERM DateType = "FIX_TERM" 269 DATETYPE_PERMANENT DateType = "PERMANENT" 270) 271 272type CommonFieldFlag string 273 274func (e CommonFieldFlag) Ptr() *CommonFieldFlag { 275 return &e 276} 277 278const ( 279 COMMONFIELDFLAG_USER_FORM_FLAG_SEX CommonFieldFlag = "USER_FORM_FLAG_SEX" 280 COMMONFIELDFLAG_USER_FORM_FLAG_NAME CommonFieldFlag = "USER_FORM_FLAG_NAME" 281 COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY" 282 COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS CommonFieldFlag = "USER_FORM_FLAG_ADDRESS" 283 COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL CommonFieldFlag = "USER_FORM_FLAG_EMAIL" 284 COMMONFIELDFLAG_USER_FORM_FLAG_CITY CommonFieldFlag = "USER_FORM_FLAG_CITY" 285) 286 287type UserCustomFieldForm struct { 288 Type *CustomFieldType `json:"type,omitempty"` 289 Name *string `json:"name,omitempty"` 290 Values []string `json:"values,omitempty"` 291} 292 293type CustomFieldType string 294 295func (e CustomFieldType) Ptr() *CustomFieldType { 296 return &e 297} 298 299const ( 300 CUSTOMFIELDTYPE_CHECK_BOX CustomFieldType = "CHECK_BOX" 301 CUSTOMFIELDTYPE_RADIO CustomFieldType = "RADIO" 302) 303
应答参数
折叠全部参数
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 种类型。目前仅支持普通会员卡,填写付费和储值类型时会返回错误。
可选取值
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 微信支付系统分配,用户领取会员卡时从微信系统分配24位数字作为会员code,并在「用户开通会员卡」事件通知中返回;
(2)MERCHANT_ALLOCATE 商家分配,商家同步会员开通结果时传入,用户开卡成功或失败都以商家传入的code作为会员卡code。选择商家分配模式时,开通事件通知中不返回 user_card_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(20480)
【商家法务协议】 指用户与商家之间签订的具有法律效力的合同文件,旨在明确双方在交易、服务提供、权利义务等方面的规则,以保障交易安全、规范商业行为,并在纠纷发生时提供法律依据。不支持链接跳转,支持使用\n代表换行,只支持纯文本展示。支持用户主动入会时必填。若该值不为空,则会返回该字段。
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.过期后不再出现服务项,且无法给用户发送会员服务消息通知
可选取值
FIX_TIME_RANGE: 必填available_begin_time和available_end_time,会员卡在此时间[available_begin_time, available_end_time)范围内有效FIX_TERM: 必填available_day_after_receive,会员卡在用户领取之后available_day_after_receive天内有效PERMANENT: 会员卡激活后永久有效
available_begin_time 选填 string
【有效期开始时间】 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
【有效期结束时间】 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_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]
【平台提供的通用开卡信息字段】 平台提供的通用开卡信息字段。若商户在会员卡模板中设置该值,则查询结果中会返回给商户。
可选取值
USER_FORM_FLAG_SEX: 用户开卡时需填写性别,字段内容可选男或女。USER_FORM_FLAG_NAME: 用户开卡时需填写姓名USER_FORM_FLAG_BIRTHDAY: 用户开卡时需填写生日,字段内容需遵循 RFC3339 标准的full-date格式:yyyy-MM-DD,表示年月日。年份必须为 4 位数,月份和日期不足两位时需补零。 示例:2015-05-20。USER_FORM_FLAG_ADDRESS: 用户开卡时需填写地址USER_FORM_FLAG_EMAIL: 用户开卡时需填写邮箱,字段内容需为合法邮箱。USER_FORM_FLAG_CITY: 用户开卡时需填写城市,字段格式需为:"省份,城市",第一项省份,第二项城市,用英文逗号分隔。
custom_field_list 选填 array[object]
【商家自定义的开卡信息字段】 商家自定义的开卡信息字段。若商户在会员卡模板中设置该值,则查询结果中会返回给商户。当前最多只允许传入1项。
type 选填 string
【字段类型】 选择所需的字段类型
可选取值
CHECK_BOX: 用户可从商家提供的选项中选择多项RADIO: 用户可从商家提供的选项中选择一项
name 选填 string(32)
【字段名称】 信息项的名称。若商户在会员卡模板中设置该值,则查询结果中会返回给商户。
values 选填 array[string(8)]
【字段值】 信息项的值列表。
特殊规则:列表最多支持10个,单个列表限制8个字符。若商户创建会员卡模板时设置该值,则查询结果中会返回给商户。
state 必填 string
【状态】 会员卡状态信息
可选取值
CARD_EFFECTIVE: 生效中CARD_INVALID: 已失效
create_time 必填 string
【创建时间】 创建会员卡的时间,需遵循 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
【更新时间】 更新会员卡的时间,需遵循 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秒。
support_user_active_join 选填 boolean
【是否支持用户主动入会】 true 表示允许用户在微信支付内主动开通这张会员卡,用户可以通过商家名片、支付相关入会入口,以及商家小程序或 H5 的入会流程填写开卡信息并开通;false 表示用户不能在微信支付内主动开通,只能由商家通过导入等方式开通。
purchase_membership 选填 boolean
【是否为付费会员】 true 表示该会员卡是付费会员,false 表示不是。
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 "support_user_active_join" : true, 66 "purchase_membership" : false 67 } 68 ], 69 "total_count" : 20, 70 "offset" : 1, 71 "limit" : 20 72} 73
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | PARAM_ERROR | 是否支持入会组件为 true 时,必须填写会员权益、回调地址、商家法务协议 | 请补齐会员权益、回调地址、商家法务协议;若不需要用户通过入会组件开通,请将是否支持入会组件设为 false |
400 | INVALID_REQUEST | 暂不支持付费或储值的会员卡类型,请修改后重试 | 请创建或使用普通会员卡模板进行操作 |
400 | PARAM_ERROR | 卡名称仅支持中英文字符、数字和标点 | 请修改卡名称,移除不支持的特殊字符 |
400 | PARAM_ERROR | Http header中缺少必填参数Wechatpay-Serial | 缺少必要商品券图片,请补充上传后重试 |
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
429 | RATELIMIT_EXCEEDED | 接口请求频率达到限制 | 请降低请求接口频率 |
400 | PARAM_ERROR | APPID无效或与品牌 ID 没有绑定关系 | 请检查AppID是否有效,并确认其与品牌ID的绑定关系 |
400 | PARAM_ERROR | 固定有效期卡模板必填有效期开始和结束时间 | 请填写具体的有效期开始和结束时间,并移除有效天数信息 |
400 | PARAM_ERROR | 商家请求单号重复 | 请更换商家请求单号,确保其唯一性 |
400 | PARAM_ERROR | 品牌ID与会员码跳转APPID没有绑定关系 | 请检查会员码跳转的AppID是否有效,并确认其与品牌ID的绑定关系 |
400 | PARAM_ERROR | 品牌ID与会员中心跳转APPID没有绑定关系 | 请检查会员中心跳转的AppID是否有效,并确认其与品牌ID的绑定关系 |
400 | PARAM_ERROR | 参数错误 | 请检查请求参数 |
400 | PARAM_ERROR | 会员码型不是“跳转商家小程序”,不允许填写会员码跳转信息 | 请移除会员码跳转信息,或将会员码型设置为跳转商家小程序 |
400 | PARAM_ERROR | 永久有效不允许设置相对有效期 | 当有效期类型为永久时,请移除领取后有效天数字段 |
400 | PARAM_ERROR | 固定时间范围不允许填写领取后有效天数 | 当有效期类型为固定时间时,请移除领取后有效天数字段 |
400 | PARAM_ERROR | 请求内容或图片不符合法规,请重试 | 请检查提交的内容或图片是否合规,修改后重试 |
400 | INVALID_REQUEST | 商家未开通商家名片会员功能 | 请联系运营为该商家开通商家名片会员功能 |
400 | PARAM_ERROR | 非储值会员卡,不允许填写储值小程序信息 | 请移除储值小程序相关信息 |
400 | INVALID_REQUEST | 会员卡模板数量超过限制,每个类型最多创建两个模板 | 请删除多余的会员卡模板,确保每个类型下模板不超过两个 |
400 | PARAM_ERROR | 参数过短 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
400 | PARAM_ERROR | 参数过长 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
400 | PARAM_ERROR | 参数错误 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
400 | PARAM_ERROR | 参数超出取值范围 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
401 | SIGN_ERROR | Http头Authorization值格式错误,请参考《微信支付商户REST API签名规则》 | Http头Authorization值格式错误,请参考《APIv3如何签名和验签》,检查传递的Authorization值是否符合规则 |
400 | INVALID_REQUEST | Http头Content-Type值必须为application/json | 需将Http头中的Content-Type值设置为application/json |
400 | PARAM_ERROR | 传入了不支持的Accept-Language | 传入了不支持的Accept-Language,支持的Accept-Language值请参考应答的语种 |
401 | SIGN_ERROR | Http头Authorization中的timestamp与发起请求的时间不得超过5分钟 | Authorization 头 timestamp 与请求时间间隔超 5 分钟,需重新生成timestamp并替换该字段后重试。 |
401 | SIGN_ERROR | Authorization不合法 | Http头未传递Authorization值或Authorization值格式错误,请参考《APIv3如何签名和验签》,检查传递的Authorization值是否符合规则 |
400 | INVALID_REQUEST | Http头缺少Accept或User-Agent | Http头缺少Accept或User-Agent,请根据API文档在请求头中补充该参数 |
400 | PARAM_ERROR | 请求中含有未在API文档中定义的参数 | 请求中含有未在API文档中定义的参数,请检查传递的参数列表是否有编写错误的字段名 |
401 | SIGN_ERROR | Http头Authorization认证类型不正确 | Http头Authorization认证类型不正确,请将认证类型修改为WECHATPAY-BRAND-SHA256-RSA2048 |
