Skip to content

查询银行信息

根据银行 ID 、银行名称,查询银行信息

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/basic_info/banks/search
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:common_data.basic_data:read 获取基础数据信息

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

查询参数

名称类型必填描述
page_sizeint分页大小,最大 100
示例值:100
数据校验规则
- 取值范围:1100
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:MDBH00000100

请求体

名称类型必填描述
bank_id_liststring\[\]银行 ID 列表,可通过批量查询员工信息等接口返回的 person_info.bank_account_list.bank_id_v2 字段获取
示例值:["MDBH00000080"]
数据校验规则
- 最大长度:100
bank_name_liststring\[\]银行名称列表,支持对银行名称精确搜索
示例值:["招商银行"]
数据校验规则
- 最大长度:100
status_listint\[\]状态列表
示例值:[1]
可选值有
- 1: 生效 - 0: 失效
默认值[1]
数据校验规则
- 最大长度:2
update_start_timestring最早更新时间
示例值:"2020-01-01 00:00:00"
update_end_timestring最晚更新时间
示例值:"2024-01-01 00:00:00"

请求体示例

json
{
    "bank_id_list": [
        "MDBH00000080"
    ],
    "bank_name_list": [
        "招商银行"
    ],
    "status_list": [
        1
    ],
    "update_start_time": "2020-01-01 00:00:00",
    "update_end_time": "2024-01-01 00:00:00"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsbank\[\]查询到的银行列表
    └ bank_idstring银行 ID
    └ bank_namei18n\[\]银行名称
      └ langstring语言编码(IETF BCP 47)
      └ valuestring文本内容
    └ bank_codestring总行代码
    └ country_region_idstring国家 / 地区 ID ,可通过查询国家 / 地区信息 接口查询
    └ statusint状态
可选值有
- 1: 生效 - 0: 失效
    └ create_timestring创建时间
    └ update_timestring更新时间
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "bank_id": "MDBH00000080",
                "bank_name": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ],
                "bank_code": "CMB",
                "country_region_id": "6862995757234914824",
                "status": 1,
                "create_time": "2020-01-01 00:00:00",
                "update_time": "2024-01-01 00:00:00"
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
5001160998Internal Server Error服务内部错误,请稍后重试。如有问题请联系技术支持

内容来源:飞书开放平台 · 自动爬取整理