接口描述
- 可以根据银行名称关键字获取收款银行的银行联行号等信息，确保能正常打款，根据开户行名称查询，并返回最多20条与之匹配的的开户行/支行信息，用于获取收款银行，联行号信息。
- 可以根据联行号精确查询支行银行名称等信息，精确获取用户的打款银行信息。
注：该接口为非必选接口，联行号信息可通过其他数据源查询确认。
接口
/v2/identity/auth/pub/organization/{flowId}/subbranch
请求方式
GET
请求头
提供两种安全接入方式，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权（优先推荐）
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
Content-Type | string | 是 | application/json;charset=UTF-8 |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击 |
Accept | string | 是 | 建议统一填写 */* |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 |
Content-MD5 | string | 是 | 当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。 |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权，固定值，Signature |
方式二：OAuth2.0鉴权（不推荐使用）
当安全接入选择OAuth2.0鉴权方式，请点击查阅详情。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 |
flowId | string | 是 | path | 实名认证流程Id |
keyWord | string | 否 | query | 银行名称（搜索关键字） 注：
|
cnapsCode | string | 否 | query | 银行联行号 注：
|
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | |
code | int | 是 | 接口响应结果码 | |
message | string | 是 | 接口响应结果描述 | |
data | object | 否 | 接口响应结果数据 | |
list | array | 否 | 匹配银行信息列表 | |
bank | string | 否 | 匹配银行总行名称 | |
bankName | string | 否 | 匹配支行完整名称 | |
cnapsCode | string | 否 | 银行联行号 | |
province | string | 否 | 支行所在省份 | |
city | string | 否 | 支行所在市/区 | |
请求示例
GET /v2/identity/auth/pub/organization/836551334533533698/subbranch?keyWord=xx银行杭州高新支行响应示例
{
"code": 0,
"message": "成功",
"data": {
"list": [{
"bankName": "xx银行杭州高新支行",
"bank": "xx银行",
"cnapsCode": "307331002584",
"city": "杭州市",
"province": "浙江"
}]
}
}错误码
错误码 | 错误描述 | 解决方案 |
30500000 | 操作出错,请联系服务人员处理 | 请核实传入的keyWord是否正确 |
30500002 | 认证流程已结束 | 请重新发起认证流程 |
30500003 | 认证流程已失效，请重新发起认证 | 请重新发起认证流程 |
30500004 | 认证流程不存在 | 请核实当前流程id是否正确 |
30500100 | keyWord与cnapsCode不能同时为空 | keyWord与cnapsCode字段需要二选一传入 |
30500101 | 参数错误：cnapsCode格式为全数字 | 请核实cnapsCode格式是否正确，不能出现非数字之外的字符。 |
我要纠错