查询品牌门店
更新时间:2025.08.04根据品牌门店ID,查询品牌门店。
频率限制:5/s
接口说明
支持商户:【品牌商户】
请求方式:【GET】/brand/store/brandstores/{store_id}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
path 路径参数
store_id 必填 string
【品牌门店ID】 创建品牌门店后,系统为该门店分配的唯一ID。
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/brand/store/brandstores/1234567890123456 \ 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 GetBrandStore { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/brand/store/brandstores/{store_id}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 GetBrandStore client = new GetBrandStore( 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 GetBrandStoreRequest request = new GetBrandStoreRequest(); 41 request.storeId = "1234567890123456"; 42 try { 43 BrandStoresEntity response = client.run(request); 44 // TODO: 请求成功,继续业务逻辑 45 System.out.println(response); 46 } catch (WXPayBrandUtility.ApiException e) { 47 // TODO: 请求失败,根据状态码执行不同的逻辑 48 e.printStackTrace(); 49 } 50 } 51 52 public BrandStoresEntity run(GetBrandStoreRequest request) { 53 String uri = PATH; 54 uri = uri.replace("{store_id}", WXPayBrandUtility.urlEncode(request.storeId)); 55 56 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 57 reqBuilder.addHeader("Accept", "application/json"); 58 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 59 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo, privateKey, METHOD, uri, null)); 60 reqBuilder.method(METHOD, null); 61 Request httpRequest = reqBuilder.build(); 62 63 // 发送HTTP请求 64 OkHttpClient client = new OkHttpClient.Builder().build(); 65 try (Response httpResponse = client.newCall(httpRequest).execute()) { 66 String respBody = WXPayBrandUtility.extractBody(httpResponse); 67 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 68 // 2XX 成功,验证应答签名 69 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 70 httpResponse.headers(), respBody); 71 72 // 从HTTP应答报文构建返回数据 73 return WXPayBrandUtility.fromJson(respBody, BrandStoresEntity.class); 74 } else { 75 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 76 } 77 } catch (IOException e) { 78 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 79 } 80 } 81 82 private final String brand_id; 83 private final String certificateSerialNo; 84 private final PrivateKey privateKey; 85 private final String wechatPayPublicKeyId; 86 private final PublicKey wechatPayPublicKey; 87 88 public GetBrandStore(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 89 this.brand_id = brand_id; 90 this.certificateSerialNo = certificateSerialNo; 91 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 92 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 93 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 94 } 95 96 public static class GetBrandStoreRequest { 97 @SerializedName("store_id") 98 @Expose(serialize = false) 99 public String storeId; 100 } 101 102 public static class BrandStoresEntity { 103 @SerializedName("store_id") 104 public String storeId; 105 106 @SerializedName("store_state") 107 public StoreState storeState; 108 109 @SerializedName("audit_state") 110 public AuditState auditState; 111 112 @SerializedName("review_reject_reason") 113 public String reviewRejectReason; 114 115 @SerializedName("store_basics") 116 public StoreBase storeBasics; 117 118 @SerializedName("store_address") 119 public StoreLocation storeAddress; 120 121 @SerializedName("store_business") 122 public StoreBusiness storeBusiness; 123 124 @SerializedName("store_recipient") 125 public List<StoreRecipient> storeRecipient; 126 } 127 128 public enum StoreState { 129 @SerializedName("OPEN") 130 OPEN, 131 @SerializedName("CREATING") 132 CREATING, 133 @SerializedName("CLOSED") 134 CLOSED 135 } 136 137 public enum AuditState { 138 @SerializedName("SUCCESS") 139 SUCCESS, 140 @SerializedName("PROCESSING") 141 PROCESSING, 142 @SerializedName("REJECTED") 143 REJECTED 144 } 145 146 public static class StoreBase { 147 @SerializedName("store_reference_id") 148 public String storeReferenceId; 149 150 @SerializedName("branch_name") 151 public String branchName; 152 } 153 154 public static class StoreLocation { 155 @SerializedName("address_code") 156 public String addressCode; 157 158 @SerializedName("address_detail") 159 public String addressDetail; 160 161 @SerializedName("address_complements") 162 public String addressComplements; 163 164 @SerializedName("longitude") 165 public String longitude; 166 167 @SerializedName("latitude") 168 public String latitude; 169 } 170 171 public static class StoreBusiness { 172 @SerializedName("service_phone") 173 public String servicePhone; 174 175 @SerializedName("business_hours") 176 public String businessHours; 177 } 178 179 public static class StoreRecipient { 180 @SerializedName("mchid") 181 public String mchid; 182 183 @SerializedName("company_name") 184 public String companyName; 185 186 @SerializedName("recipient_state") 187 public RecipientState recipientState; 188 } 189 190 public enum RecipientState { 191 @SerializedName("CONFIRMED") 192 CONFIRMED, 193 @SerializedName("ADMIN_REJECTED") 194 ADMIN_REJECTED, 195 @SerializedName("CONFIRMING") 196 CONFIRMING, 197 @SerializedName("TIMEOUT_REJECTED") 198 TIMEOUT_REJECTED 199 } 200 201} 202
需配合微信支付工具库 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 "strings" 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 := &GetBrandStoreRequest{ 27 StoreId: wxpay_brand_utility.String("1234567890123456"), 28 } 29 30 response, err := GetBrandStore(config, request) 31 if err != nil { 32 fmt.Printf("请求失败: %+v\n", err) 33 // TODO: 请求失败,根据状态码执行不同的处理 34 return 35 } 36 37 // TODO: 请求成功,继续业务逻辑 38 fmt.Printf("请求成功: %+v\n", response) 39} 40 41func GetBrandStore(config *wxpay_brand_utility.BrandConfig, request *GetBrandStoreRequest) (response *BrandStoresEntity, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "GET" 45 path = "/brand/store/brandstores/{store_id}" 46 ) 47 48 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 49 if err != nil { 50 return nil, err 51 } 52 reqUrl.Path = strings.Replace(reqUrl.Path, "{store_id}", url.PathEscape(*request.StoreId), -1) 53 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 54 if err != nil { 55 return nil, err 56 } 57 httpRequest.Header.Set("Accept", "application/json") 58 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 59 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 60 if err != nil { 61 return nil, err 62 } 63 httpRequest.Header.Set("Authorization", authorization) 64 65 client := &http.Client{} 66 httpResponse, err := client.Do(httpRequest) 67 if err != nil { 68 return nil, err 69 } 70 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 71 if err != nil { 72 return nil, err 73 } 74 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 75 // 2XX 成功,验证应答签名 76 err = wxpay_brand_utility.ValidateResponse( 77 config.WechatPayPublicKeyId(), 78 config.WechatPayPublicKey(), 79 &httpResponse.Header, 80 respBody, 81 ) 82 if err != nil { 83 return nil, err 84 } 85 response := &BrandStoresEntity{} 86 if err := json.Unmarshal(respBody, response); err != nil { 87 return nil, err 88 } 89 90 return response, nil 91 } else { 92 return nil, wxpay_brand_utility.NewApiException( 93 httpResponse.StatusCode, 94 httpResponse.Header, 95 respBody, 96 ) 97 } 98} 99 100type GetBrandStoreRequest struct { 101 StoreId *string `json:"store_id,omitempty"` 102} 103 104func (o *GetBrandStoreRequest) MarshalJSON() ([]byte, error) { 105 type Alias GetBrandStoreRequest 106 a := &struct { 107 StoreId *string `json:"store_id,omitempty"` 108 *Alias 109 }{ 110 // 序列化时移除非 Body 字段 111 StoreId: nil, 112 Alias: (*Alias)(o), 113 } 114 return json.Marshal(a) 115} 116 117type BrandStoresEntity struct { 118 StoreId *string `json:"store_id,omitempty"` 119 StoreState *StoreState `json:"store_state,omitempty"` 120 AuditState *AuditState `json:"audit_state,omitempty"` 121 ReviewRejectReason *string `json:"review_reject_reason,omitempty"` 122 StoreBasics *StoreBase `json:"store_basics,omitempty"` 123 StoreAddress *StoreLocation `json:"store_address,omitempty"` 124 StoreBusiness *StoreBusiness `json:"store_business,omitempty"` 125 StoreRecipient []StoreRecipient `json:"store_recipient,omitempty"` 126} 127 128type StoreState string 129 130func (e StoreState) Ptr() *StoreState { 131 return &e 132} 133 134const ( 135 STORESTATE_OPEN StoreState = "OPEN" 136 STORESTATE_CREATING StoreState = "CREATING" 137 STORESTATE_CLOSED StoreState = "CLOSED" 138) 139 140type AuditState string 141 142func (e AuditState) Ptr() *AuditState { 143 return &e 144} 145 146const ( 147 AUDITSTATE_SUCCESS AuditState = "SUCCESS" 148 AUDITSTATE_PROCESSING AuditState = "PROCESSING" 149 AUDITSTATE_REJECTED AuditState = "REJECTED" 150) 151 152type StoreBase struct { 153 StoreReferenceId *string `json:"store_reference_id,omitempty"` 154 BranchName *string `json:"branch_name,omitempty"` 155} 156 157type StoreLocation struct { 158 AddressCode *string `json:"address_code,omitempty"` 159 AddressDetail *string `json:"address_detail,omitempty"` 160 AddressComplements *string `json:"address_complements,omitempty"` 161 Longitude *string `json:"longitude,omitempty"` 162 Latitude *string `json:"latitude,omitempty"` 163} 164 165type StoreBusiness struct { 166 ServicePhone *string `json:"service_phone,omitempty"` 167 BusinessHours *string `json:"business_hours,omitempty"` 168} 169 170type StoreRecipient struct { 171 Mchid *string `json:"mchid,omitempty"` 172 CompanyName *string `json:"company_name,omitempty"` 173 RecipientState *RecipientState `json:"recipient_state,omitempty"` 174} 175 176type RecipientState string 177 178func (e RecipientState) Ptr() *RecipientState { 179 return &e 180} 181 182const ( 183 RECIPIENTSTATE_CONFIRMED RecipientState = "CONFIRMED" 184 RECIPIENTSTATE_ADMIN_REJECTED RecipientState = "ADMIN_REJECTED" 185 RECIPIENTSTATE_CONFIRMING RecipientState = "CONFIRMING" 186 RECIPIENTSTATE_TIMEOUT_REJECTED RecipientState = "TIMEOUT_REJECTED" 187) 188
应答参数
200 OK
store_id 选填 string
【品牌门店ID】 创建品牌门店后,系统为该门店分配的唯一ID。
store_state 选填 string
【门店状态】 用于描述门店当前状态
可选取值
OPEN: 门店生效中。门店审核通过创建成功后即为生效中,后续更新门店信息只会影响审核状态,不会改变门店状态,如门店暂停营业可调用“暂停门店营业 API”,如门店关闭可调用“删除品牌门店 API”。门店营业时间不影响门店状态。CREATING: 门店创建中。在创建门店后,门店资料正在审核。审核详情请查看审核状态。CLOSED: 门店停业中。不可用于微信支付生态中的其他业务,可删除该门店,删除后将无法恢复,请谨慎操作。
audit_state 选填 string
【审核状态】 创建、修改门店时,通过此字段可得知当前审核状态
可选取值
SUCCESS: 门店资料审核通过。PROCESSING: 门店资料审核中,请等待审核结果。REJECTED: 门店资料被驳回,请根据驳回原因进行修改。
review_reject_reason 选填 string
【审核失败原因】 门店资料审核失败的原因
store_basics 选填 object
【门店基础信息】 用于描述门店编码,名称等基本情况。
| 属性 | |
store_reference_id 选填 string(32) 【商家门店编号】 商家内部的门店编号,最长32位字符;商家自行保证该编码在商家内部的唯一性。不允许有符号表情。 此字段为免审字段(仅修改免审字段时,将会直接更新门店,无需审核)。 branch_name 选填 string(50) 【门店名称】 只需填写纯粹的分店名称,例如:"南山店"、"朝阳门店"、"天河城店"
|
store_address 选填 object
【门店地址信息】 用于描述门店地址,经纬度等地理位置相关情况。
| 属性 | |
address_code 必填 string(20) 【门店省市编码】 门店所在省市区编码,只能由数字组成;详细参见微信支付提供的省市对照表。 address_detail 必填 string(200) 【门店地址】 门店地址为核心重要信息,请准确填写并精确到门牌号,该信息涉及到地址核实、营销活动等业务,说明:不要重复填写省市区信息。 address_complements 选填 string(50) 【门店地址辅助描述】 门店周围标志性建筑,用于辅助定位。 longitude 选填 string(32) 【门店经度】 经度,取值在[-180,180]之间的数字,经度长度不能超过32个字符,腾讯地图经纬度查询:https://lbs.qq.com/tool/getpoint/index.html latitude 选填 string(32) 【门店纬度】 纬度,取值在[-90,90]之间的数字,纬度长度不能超过32个字符,腾讯地图经纬度查询:https://lbs.qq.com/tool/getpoint/index.html |
store_business 选填 object
【门店经营信息】 用于描述门店联系电话,经营时间等经营状况。
| 属性 | |
service_phone 选填 string(32) 【门店服务电话】 支持座机和手机,只支持数字和“-”符号,最多支持两个电话,两个电话间用英文竖线“|”区隔。 此字段为免审字段(仅修改免审字段时,将会直接更新门店,无需审核)。 business_hours 选填 string(256) 【门店经营时间】 经营时间需要使用指定格式,如下:
|
store_recipient 选填 array[object]
【门店收款信息】 门店收款商户列表。
| 属性 | |
mchid 选填 string(16) 【门店收款商户号】 门店的收款商户号,仅支持绑定品牌已关联的商户号。 company_name 选填 string(256) 【门店收款主体】 门店收款的主体信息,支持企业,个体户,小微。 recipient_state 选填 string 【收款绑定状态】 门店收款商户号的绑定状态 可选取值
|
应答示例
200 OK
1{ 2 "store_id" : "1234567890123456", 3 "store_state" : "OPEN", 4 "audit_state" : "SUCCESS", 5 "review_reject_reason" : "通过核实,您提交的电话错误,请核实手机号码或座机号码是否正确", 6 "store_basics" : { 7 "store_reference_id" : "MDL001", 8 "branch_name" : "海岸城店" 9 }, 10 "store_address" : { 11 "address_code" : "440305", 12 "address_detail" : "深南大道10000号腾讯大厦1楼", 13 "address_complements" : "地铁A口右侧100米", 14 "longitude" : "112.63484", 15 "latitude" : "37.75464" 16 }, 17 "store_business" : { 18 "service_phone" : "0755-86013388|0755-86013399", 19 "business_hours" : "周一至周五 09:00-20:00|周六至周日 10:00-次日22:00" 20 }, 21 "store_recipient" : [ 22 { 23 "mchid" : "1230000109", 24 "company_name" : "腾讯科技(深圳)有限公司", 25 "recipient_state" : "CONFIRMED" 26 } 27 ] 28} 29
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
404 | NOT_FOUND | 品牌门店不存在 | 请确认门店存在且属于该品牌 |
400 | PARAM_ERROR | 参数错误 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
429 | RATELIMIT_EXCEEDED | 请求超过频率限制 | 请稍后使用原参数重试 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后使用原参数重试 |

