最新更新時間:2021.05.14 版本說明
本接口可以用于根據(jù)銀行別名編碼(僅支持需要填寫支行的銀行別名編碼)和城市編碼過濾查詢支行列表數(shù)據(jù)
? 如需根據(jù)關(guān)鍵詞檢索,請在前端緩存所有支行數(shù)據(jù)并自行完成檢索功能;
? 業(yè)務(wù)查詢到的數(shù)據(jù)為后端緩存快照,業(yè)務(wù)方需要定期淘汰并更新數(shù)據(jù);
? 單商戶單接口最大請求頻率不超過300TPS;
適用對象: 服務(wù)商
請求URL:https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/{bank_alias_code}/branches
請求方式:GET
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)為URL參數(shù)
body 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
銀行別名編碼 | bank_alias_code | string[1, 32] | 是 | path銀行別名的編碼,查詢支行接口僅支持需要填寫支行的銀行別名編碼。 示例值:1000006247 |
城市編碼 | city_code | int | 是 | query城市編碼,唯一標(biāo)識一座城市,用于結(jié)合銀行別名編碼查詢支行列表 示例值:536 |
本次查詢偏移量 | offset | int | 否 | query非負(fù)整數(shù),表示該次請求資源的起始位置,從0開始計數(shù)。調(diào)用方選填,默認(rèn)為0。offset為20,limit為100時,查詢第21-120條數(shù)據(jù) |
本次請求最大查詢條數(shù) | limit | int | 是 | query非0非負(fù)的整數(shù),該次請求可返回的最大資源條數(shù)。 示例值:200 |
https://api.mch.weixin.qq.com/v3/capital/capitallhh/banks/1000006247/branches?city_code=536&offset=0&limit=200
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
查詢數(shù)據(jù)總條數(shù) | total_count | int | 是 | 經(jīng)過條件篩選,查詢到的支行總數(shù) 示例值:10 |
本次查詢條數(shù) | count | int | 是 | 本次查詢到的支行數(shù)據(jù)條數(shù) 示例值:10 |
+支行列表 | data | array | 否 | 單次查詢返回的支行列表結(jié)果數(shù)組 |
本次查詢偏移量 | offset | int | 是 | 該次請求資源的起始位置,請求中包含偏移量時應(yīng)答消息返回相同偏移量,否則返回默認(rèn)值0。 示例值:0 |
+分頁鏈接 | links | object | 是 | 返回前后頁和當(dāng)前頁面的訪問鏈接 |
開戶銀行 | account_bank | string[1, 128] | 是 | 查詢到的支行所屬開戶銀行的名稱,非直連銀行統(tǒng)一為其他銀行 示例值:招商銀行其他銀行 |
開戶銀行編碼 | account_bank_code | int | 是 | 查詢到的支行所屬開戶銀行的開戶銀行編碼,可用于付款到銀行卡等場景中指定銀行卡的開戶銀行 示例值:1001 |
銀行別名 | bank_alias | string[1, 128] | 是 | 查詢到的支行所屬銀行的銀行別名 示例值:工商銀行深圳前海微眾銀行 |
銀行別名編碼 | bank_alias_code | string[1, 32] | 是 | 查詢到的支行所屬銀行的銀行別名編碼,用于校驗回包 示例值:1000006247 |
{
"total_count": 10,
"count": 10,
"data": [
{
"bank_branch_name": "中國工商銀行上海市周浦支行",
"bank_branch_id": "102290072311"
}
],
"offset": 0,
"links": {
"next": "/v3/capital/capitallhh/banks/1001/branches?offset=10&limit=5",
"prev": "/v3/capital/capitallhh/banks/1001/branches?offset=0&limit=5",
"self": "/v3/capital/capitallhh/banks/1001/branches?offset=5&limit=5"
},
"account_bank": "招商銀行其他銀行",
"account_bank_code": 1001,
"bank_alias": "工商銀行深圳前海微眾銀行",
"bank_alias_code": "1000006247"
}
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_REQUEST | 銀行別名編碼非數(shù)字格式 | 根據(jù)錯誤提示,傳入正確參數(shù) |
404 | NOT_FOUND | 查詢結(jié)果為空 | 請商戶檢查需要查詢的id或者請求URL是否正確 |
429 | FREQUENCY_LIMITED | 頻率限制 | 調(diào)用太頻繁,請降低調(diào)用接口頻率 |