/data/cnaps/search
1.接口描述
该API的功能按支行关键字 + 可选条件分页检索联行号。
请求方式:
POST
请求URL:
https://cloudapi.deepfinch.com/data/cnaps/search
调试工具
2.请求参数
2.1 请求头域
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API调用凭证信息,详细信息请参考API调用 |
| X-DF-API-SECRET | string | 是 | API调用凭证信息,详细信息请参考API调用 |
2.2 请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| bank_no | string | 否 | 银行卡号,16–19 位纯数字;BIN 识别后作为支行关键字参与检索 |
| province | string | 否 | 省份,trigram 匹配(3+ 字符)/ LIKE 兜底(<3 字符) |
| city | string | 否 | 城市,同上 |
| bch_key | string | 否 | 支行名称关键字,支持空格分隔多关键词(AND);为空时仅按 province/city 过滤 |
| page | int | 否 | 分页选项,第几页,从1开始;默认值1 |
3.返回参数
正常响应 (200)
| 字段 | 类型 | 描述 |
|---|---|---|
| request_id | string | 本次请求的 id |
| status | string | 状态。正常为 OK ,其他值表示失败。详见错误码 |
| result | object | 查询结果 |
其中result的字段如下:
| 字段 | 类型 | 描述 |
|---|---|---|
| medical_type | string | 所属大类 |
totalpage | int | 总页数 | | totalcount | int | 命中总记录数 | | page | int | 当前页码 | | bank | null | 已废弃,始终为 null | | bankIdentified | string | 银行卡号 BIN 识别出的行名(回显);未传 bank_no 时为 null | | bchKey | string | 本次查询实际使用的支行关键字 | | bankNo | string | 传入的银行卡号(回显);未传时为 null | | province | string | 传入的省份(回显);未传时为 null | | city | string | 传入的城市(回显);未传时为 null | | records | array | 联行号记录列表,每条约 20 条 |
其中records的字段如下:
| 字段 | 类型 | 描述 |
|---|---|---|
| bank_code | string | 大行行号(如 "104") |
| bank_name | string | 大行名称(如 "中国银行") |
| bch_name | string | 支行名称 |
| province | string | 所在省份 |
| city | string | 所在城市 |
| bch_addr | string | 支行地址(源数据多为空) |
| cnaps_code | string | 联行号(12 位) |
输出示例:
{
"request_id": "TIDce84aeceec0c4bf881ccc3698a48ce6e",
"status": "OK",
"result": {
"totalpage": 210,
"totalcount": 4183,
"page": 1,
"bank": null,
"bank_identified": null,
"bch_key": "",
"bank_no": null,
"province": "北京市",
"city": null,
"records": [
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "CFS",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100000007"
},
{
"bank_code": "011",
"bank_name": "国家金库",
"bch_name": "国家金库总库",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "011100099992"
},
{
"bank_code": "012",
"bank_name": "",
"bch_name": "支付业务收费专户",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "012100088887"
},
{
"bank_code": "104",
"bank_name": "中国银行",
"bch_name": "中国银行总行",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "104100000004"
},
{
"bank_code": "907",
"bank_name": "",
"bch_name": "国投财务有限公司",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "907100000054"
},
{
"bank_code": "907",
"bank_name": "",
"bch_name": "南车财务有限公司",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "907100000433"
},
{
"bank_code": "907",
"bank_name": "",
"bch_name": "中信财务有限公司",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "907100000530"
},
{
"bank_code": "902",
"bank_name": "",
"bch_name": "公开市场业务操作室",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "902100011119"
},
{
"bank_code": "907",
"bank_name": "",
"bch_name": "中节能财务有限公司",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "907100000521"
},
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "ABC089",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100000890"
},
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "ABC158",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100001585"
},
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "ABC164",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100001649"
},
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "ABC228",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100002289"
},
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "ABC231",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100002310"
},
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "ABC232",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100002328"
},
{
"bank_code": "991",
"bank_name": "备付金账户",
"bch_name": "ABC243",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "991100002432"
},
{
"bank_code": "303",
"bank_name": "中国光大银行",
"bch_name": "中国光大银行",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "303100000006"
},
{
"bank_code": "304",
"bank_name": "华夏银行",
"bch_name": "华夏银行北京分行",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "304100042691"
},
{
"bank_code": "326",
"bank_name": "中信百信银行",
"bch_name": "中信百信银行",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "326100010008"
},
{
"bank_code": "907",
"bank_name": "",
"bch_name": "中冶集团财务有限公司",
"province": "北京市",
"city": "北京市",
"bch_addr": "",
"cnaps_code": "907100000079"
}
]
}
}
4.错误码
| 状态码 | status 字段 |
说明 |
|---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
QUERY_FAILED | 查询失败 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
输出示例:
{
"status": "RATE_LIMIT_EXCEEDED",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}