调用价格
5 匠币/次
快速接入
保持统一返回结构,直接通过服务端发起请求即可接入。
https://openapi.toolkk.com/v1/bank-cnaps-code-querycURL 示例
curl --request POST \
--url 'https://openapi.toolkk.com/v1/bank-cnaps-code-query' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: YOUR_API_KEY' \
--data '{\n "bank": "中国工商银行",\n "city": "深圳市",\n "page": "1"\n}'Python 示例
import os
import requests
url = "https://openapi.toolkk.com/v1/bank-cnaps-code-query"
payload = {
"bank": "中国工商银行",
"city": "深圳市",
"page": "1"
}
headers = {
"Content-Type": "application/json",
"X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"),
}
response = requests.request("POST", url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())Go 示例
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
endpoint := "https://openapi.toolkk.com/v1/bank-cnaps-code-query"
payload := []byte("{\n \"bank\": \"中国工商银行\",\n \"city\": \"深圳市\",\n \"page\": \"1\"\n}")
req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}Java 示例
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ToolkkExample {
public static void main(String[] args) throws Exception {
String payload = "{\n \"bank\": \"中国工商银行\",\n \"city\": \"深圳市\",\n \"page\": \"1\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://openapi.toolkk.com/v1/bank-cnaps-code-query"))
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.header("Content-Type", "application/json")
.header("X-API-Key", "YOUR_API_KEY")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}PHP 示例
<?php
$endpoint = 'https://openapi.toolkk.com/v1/bank-cnaps-code-query';
$payload = "{\n \"bank\": \"中国工商银行\",\n \"city\": \"深圳市\",\n \"page\": \"1\"\n}";
$ch = curl_init($endpoint);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'X-API-Key: YOUR_API_KEY',
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;响应示例
{
"code": "SUCCESS",
"message": "成功",
"data": {
"page": "1",
"totalpage": "1",
"totalcount": "1",
"record": [
{
"bankCode": "102584000000",
"lname": "中国工商银行股份有限公司深圳某支行",
"bank": "中国工商银行",
"province": "广东省",
"city": "深圳市",
"addr": "深圳市某区",
"tel": "0755-00000000"
}
]
}
}示例用于理解返回结构,实际结果以接口返回为准。
- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 60 次/分钟
- 超时时间
- 10000 ms
服务端调用时,将 API Key 放在 X-API-Key 请求头中。
建议按 response code 与业务字段双重判断调用结果。
高频调用场景请结合速率限制与重试策略使用。
请求字段
从服务端发起请求,并在 X-API-Key 请求头中传入密钥。
请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| bank | string | 未标注 | 未标注 | 中国工商银行 |
| city | string | 未标注 | 未标注 | 深圳市 |
| page | string | 未标注 | 未标注 | 1 |
请求示例
{
"bank": "中国工商银行",
"city": "深圳市",
"page": "1"
}- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 60 次/分钟
- 超时时间
- 10000 ms
响应字段
示例用于理解返回结构,实际结果以接口返回为准。
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| code | string | 未标注 | 未标注 | SUCCESS |
| message | string | 未标注 | 未标注 | 成功 |
| data | object | 未标注 | 未标注 | {...} |
| data.page | string | 未标注 | 未标注 | 1 |
| data.totalpage | string | 未标注 | 未标注 | 1 |
| data.totalcount | string | 未标注 | 未标注 | 1 |
| data.record | array | 未标注 | 未标注 | [{"bankCode":"102584000000","lname":"中国工商银行股份有限公司深圳某支行","bank":"中国工商银行","province":"广东省","city":"深圳市","addr":"深圳市某区","tel":"0755-00000000"}] |
| data.record[] | object | 未标注 | 未标注 | {...} |
响应示例
{
"code": "SUCCESS",
"message": "成功",
"data": {
"page": "1",
"totalpage": "1",
"totalcount": "1",
"record": [
{
"bankCode": "102584000000",
"lname": "中国工商银行股份有限公司深圳某支行",
"bank": "中国工商银行",
"province": "广东省",
"city": "深圳市",
"addr": "深圳市某区",
"tel": "0755-00000000"
}
]
}
}$.code == 200接口简介
接口能力、应用场景、使用限制与常见问题。
能力范围
查询中国境内银行网点的联行号及基础资料,可用银行、地区或关键词等条件缩小范围,并分页获取候选支行。返回信息可包含联行号、支行全称、省市、地址和电话,适合补全开户行资料。
适用场景
- 企业付款表单:按收款方提供的银行和地区列出候选支行,让经办人确认后保存行号与支行全称。
- 财务系统补全:检索已有银行资料,将返回网点与收款方信息逐项核对。
- 客服查询:利用地址与电话辅助定位或联系具体网点,办理信息仍以银行确认为准。
接入与结果解读
例如通过 bank 加 city 查询,再用 page 读取后续结果。先检查响应状态,再遍历 data.record,结合 totalcount、totalpage 判断是否需要翻页。将 bankCode 保留为字符串,与 lname 成对展示;同名或相似支行应结合省市、地址区分,不能仅按名称相似度自动选中。
限制与核验建议
接口未承诺数据完整覆盖或固定更新周期。空结果不能证明网点不存在,返回的行号也可能需要进一步核实有效状态。正式付款前应由收款方或开户银行确认具体支行和行号。银行卡号查询不能验证持卡人身份、账户所有权或账户可用性,也不保证转账成功。
常见问题
没有返回记录时应如何处理?
先减少或调整组合条件,核对银行全称、省市写法和关键词,再重新查询。仍无结果时应转人工并联系收款方或开户银行确认,不能把空结果当作网点不存在。