查询支行列表

更新时间：2024.11.18

本接口可以用于根据银行别名编码（仅支持需要填写支行的银行别名编码）和城市编码过滤查询支行列表数据，查询时请注意：

如需根据关键词检索，请在前端缓存所有支行数据并自行完成检索功能；
业务查询到的数据为后端缓存快照，业务方需要定期淘汰并更新数据；
API按照接口-商户级别限频，单商户单接口最大请求频率不超过300TPS；

接口说明

支持商户：【普通服务商】

请求方式：【GET】/v3/capital/capitallhh/banks/{bank_alias_code}/branches

请求域名：【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

　　　　　【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点，指引点击查看

请求参数

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

path 路径参数

bank_alias_code 　必填 string(32)

【银行别名编码】银行别名的编码，查询支行接口仅支持需要填写支行的银行别名编码。

query 查询参数

city_code 　必填 integer

【城市编码】城市编码，唯一标识一座城市，用于结合银行别名编码查询支行列表

offset 　选填 integer

【本次查询偏移量】非负整数，表示该次请求资源的起始位置，从0开始计数。调用方选填，默认为0。offset为20，limit为100时，查询第21-120条数据

limit 　必填 integer

【本次请求最大查询条数】非0非负的整数，该次请求可返回的最大资源条数。

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/1000009561/branches?city_code=10&offset=100&limit=1 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

total_count 　必填 integer

【查询数据总条数】经过条件筛选，查询到的支行总数

count 　必填 integer

【本次查询条数】本次查询到的支行数据条数

data 　选填 array[object]

【支行列表】单次查询返回的支行列表结果数组

属性

offset 　必填 integer

【本次查询偏移量】该次请求资源的起始位置，请求中包含偏移量时应答消息返回相同偏移量，否则返回默认值0。

links 　必填 object

【分页链接】返回前后页和当前页面的访问链接

属性

account_bank 　必填 string(128)

【开户银行】查询到的支行所属开户银行的名称，非直连银行统一为其他银行，详见开户银行对照表

account_bank_code 　必填 integer

【开户银行编码】查询到的支行所属开户银行的开户银行编码，可用于付款到银行卡等场景中指定银行卡的开户银行，详见开户银行对照表

bank_alias 　必填 string(128)

【银行别名】查询到的支行所属银行的银行别名

bank_alias_code 　必填 string(32)

【银行别名编码】查询到的支行所属银行的银行别名编码，用于校验回包

应答示例

200 OK

1{
2  "total_count" : 107,
3  "count" : 1,
4  "data" : [
5    {
6      "bank_branch_name" : "招商银行股份有限公司北京分行",
7      "bank_branch_id" : "308100005019"
8    }
9  ],
10  "offset" : 100,
11  "links" : {
12    "next" : "/v3/capital/capitallhh/banks/1000009561/branches?offset=101&limit=1",
13    "prev" : "/v3/capital/capitallhh/banks/1000009561/branches?offset=99&limit=1",
14    "self" : "/v3/capital/capitallhh/banks/1000009561/branches?offset=100&limit=1"
15  },
16  "account_bank" : "招商银行",
17  "account_bank_code" : 1001,
18  "bank_alias" : "招商银行",
19  "bank_alias_code" : "1000009561"
20}
21

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅接口规则
401	SIGN_ERROR	验证不通过	请参阅签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	银行别名编码非数字格式	根据错误提示，传入正确参数.
404	NOT_FOUND	查询结果为空	请商户检查需要查询的ID或者请求URL是否正确
429	FREQUENCY_LIMITED	频率限制	调用太频繁，请降低调用接口频率。

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服