银行代码(BIC)/银行国际代码验证应用程序界面(API)

如何将银行代码(BIC)验证应用程序界面(API)整合到您在用的软件中

1. 什么是银行代码(BIC)验证应用程序界面(API)?

执行电汇付款和与国际银行账户(IBAN)有关的付款时,提供准确的银行国际代码/银行代码(BIC),是付款成功的关键。
本公司采用环球同业金融信息通讯协会(S.W.I.F.T. SCRL)授权数据,建立的正式银行代码(BIC)字典,成为了自动验证银行代码(BIC)的一种便捷而有效的方式。使用该服务,您就可利用贵公司在用软件查询银行代码(BIC)字典,提供贵公司内部使用了。

银行代码(BIC)验证应用程序界面(API)包含有SWIFTRef数据。界面对银行代码(BIC)数据的使用获得了全球同业银行金融通讯协会(S.W.I.F.T. SCRL)的认可。数据库版权所有。 2019

2. 特点

银行代码(BIC)验证应用程序界面(API)主要特点:

  • 能依据银行代码(BIC)检索银行信息。
  • 提供银行名称及其国别的部分信息,即可搜索银行代码(BIC)字典。
  • 能搜索银行代码(BIC)字典,查看历史记录。
  • 利用完整而简化的应用程序界面(API)响应,让功能整合变得更加轻松。


3. 应用程序界面(API)用途

银行代码(BIC)验证应用程序界面(API)基于REST,并支持简单的HTTP GET或POST请求。

接受参数如下表所示:

字段名称 长度 类型 说明
银行代码(BIC) 11 字符串 待查询的银行代码(BIC)/银行国际代码,包含8或11个字符。
银行_名称 256 字符串 用于银行代码(BIC)字典搜索的银行不完整名称。
国家 2 字符串 两个字母组成的国家代码,使用银行名称搜索时才需要。
api_密钥 128 字符串 您的专属应用程序界面(API)密钥。
格式 4 字符串 为返回数据指定格式时需要。目前支持格式:json、xml。
限制 整数 选用:可用于依据银行名称搜索时,对结果的数字做出限制。
历史记录 整数 选用:可用于显示数据库历史记录,以便进行银行和银行代码(BIC)搜索。
您可以在在线借口中找到自己的API密钥及请求端点URL。请求端点URL用于确保搜索请求。


4. 应用程序界面(API)XML响应架构

您可以下载该应用程序界面(API)响应
一个XSD方案 。 返回字段的详细说明如下表所示:

字段名称 类型 长度 始终显示 说明
修改标记 字母 1 在增量文件中:
• A (添加)
• M (修改)
• D (删除) 在任何文件中:
• A (添加)
变更后字段D 数字 186 将字段(或标签)记录为修改结果或新事件结果
按照数字顺序标识1列或更多列,1个数字代表由之前记录事例或事件变更而来的1列。
例如"6,7,8,9"
代表事件类型、事件日期、BIC8和分行银行代码(BIC)已
变更。
以下字段不包含在变更后字段记录中:
• 记录密钥
• 变更后字段
• 修改标识
记录密钥 字母数字 12 文件中该记录的唯一密钥
每条记录代表银行代码(BIC)使用周期内的一个事件。
记录密钥一经指定将保持不变。
之前的记录密钥 字母数字 12 之前链接事件的记录密钥
链接相关所有事件,并依据该信息对其定位。
下一个记录密钥 字母数字 12 下一个相关链接事件的记录密钥
链接相关所有事件,并依据该信息对其定位。
事件类型 字母 32 过去、现在或未来将要发生的、与该银行代码(BIC)有关的事件或变更说明。
事件类型:
• 已公布的银行代码(BIC)
• 已过期的银行代码(BIC)
• FIN激活银行代码(BIC)
• FA激活银行代码(BIC)
• IA激活银行代码(BIC)
• FIN取消激活的银行代码(BIC)
• FA取消激活的银行代码(BIC)
• IA取消激活的银行代码(BIC)
• 已取消激活的银行代码(BIC)
• 待处理银行代码(BIC)
• 已重新激活的银行代码(BIC)
• 已公布的银行代码(BIC)
• 银行代码(BIC)对应法定名称已变更
• 银行代码(BIC)对应机构名称已变更
• 银行代码(BIC)对应地址已变更
• FIN服务代码已变更
银行代码序列的最后一行代表最近更新日期(即:最新录入内容)
添加一个新事件时,修改标记和已变更的
字段列将在最近的前一个相关事件中更新。
事件日期 字母数字 8 事件日期
BIC8 字母数字 8 银行代码(BIC)(机构、国别与银行后置代码)构成:
• 银行前置代码(4个字符)
• 国家代码(2个字符)
• 银行后置代码(2个字符)
分行识别码 字母数字 3 分行识别码与8个字符的银行代码(BIC)有关。若分行识别码不存在,那么用XXX表示。
银行代码(BIC) 字母数字 11 完整银行代码(BIC):8个字符的银行代码(BIC)和分行识别码构成
记录状态 字母 1 记录状态标识:
• [C] = 代表事件链中直到字典发布日期为止的最新事件,不包含用[F]标识的未来事件
• [H] = 事件链中的历史记录
• [F] = 将在字典发布日期后发生的未来事件。之前标识为[c]的目前事件,即直到字典发布日期为止的最新事件,将在[F]标识事件,即未来事件的指定日期前保持有效。
未来事件的日期指变更生效的起始日期。
操作活跃记录 字母 1 同一个银行代码(BIC)可对应多条记录。该字段表示同一个银行代码(BIC)对应的哪一条记录是操作活跃银行代码,且应是可以使用的。
• [Y] 操作活跃
• [N] 操作不活跃
对于具有唯一性的每一个银行代码(BIC)而言,一条记录的录入就代表一次活跃状态(Y).
[H]标识记录,即有历史状态标识的记录将始终标记为[N]。
[C]标识,即有直到发布日期为止的最新事件标识的记录可以用[Y] 或 [N]标识。.
[F]标识,即有未来事件标识的记录将始终用[N]标识
子类型标识 任何类型 4 实体的商业类型。子类型标识仅提供用于一个银行代码(BIC)的记录。
SWIFT FIN 字母 1 一个实体与FIN的连接状态:
• [Y] 已与FIN连接
• [N] 未与FIN连接
SWIFT FA 字母 1 一个实体的FileAct的连接状态:
• [Y] 已与FileAct连接
• [N] 未与FileAct连接
SWIFT IA 字母 1 一个实体与InterAct的连接状态:
• [Y] 已与InterAct连接
• [N] 未与InterAct连接
法定名称 任何 105 机构法定名称
机构名称 任何 105 机构营业名称(公布名称))
机构类型 字母 12 主要从事金融中介及/或辅助金融活动的组织。
机构类型:
• 金融类
• 非金融类
实体类型 字母 16 识别金融实体的类型:
• 合法实体
• 分支机构
• 运营实体
注册街道地址1 任何 35 [注册] 街道名称
注册街道地址2 任何 35 [注册] 街道编号
注册街道地址3 任何 35 [注册] 建筑、建筑名称与楼层
注册街道地址4 任何 35 [注册]区域
注册城市 任何 35 [注册]机构/分支机构所在城市的名称
注册国别、省及州 任何 90 [注册] 所有人机构/分支机构所在的国家、省、州或其他行政区
注册邮编 任何 15 [注册] 机构/分支机构的邮编
注册邮政信箱号 任何 35 以逗号分隔的字段,包含机构/分支机构的邮政信箱号和相关邮编。
例如
"邮政信箱 103352, 40024"
借助该邮政信箱号,客户可以获知并使用其完整邮政信箱地址:
邮政信箱 103352
邮编40024 杜塞尔多夫(市)
经营街道地址1 任何 35 [经营] 街道名称
经营街道地址2 任何 35 [经营] 街道编号
经营街道地址3 任何 35 [经营]建筑、建筑名称及楼层
经营所在街道地址4 任何 35 [经营]区域
经营所在城市 任何 35 [经营] 机构/分支机构所在城市的名称
经营所在国家、省及州 任何 90 [经营] 所有人机构/分支机构所在的国家、省、州或其他行政区
经营用邮政编码 任何 15 [经营] 机构/分支机构邮编
经营用邮政信箱号 任何 35 以逗号分隔的字段,包含机构/分支机构的邮政信箱号和相关邮编。
例如
"邮政信箱 103352, 40024"
依据该信箱号,客户可以获知并使用其对应的完整邮政信箱地址:
邮政信箱 103352
400224,杜塞尔多夫(市)
分支机构街道地址1 任何 35 [分支机构] 街道名称
分支机构街道地址2 任何 35 [分支机构] 街道号
分支机构街道地址3 任何 35 [分支机构] 建筑、建筑名称及楼层
分支机构街道地址4 任何 35 [分支机构]区域
分支机构所在城市 任何 35 [分支机构]机构/分支机构所在城市的名称
分支机构所在国家、省及州 任何 90 [分支机构] 所有人机构/分支机构所在国家、省及州或其他行政区
分支机构邮编 任何 15 [分支机构] 机构/分支机构邮编
分支机构邮政信箱号 任何 35 以逗号分隔的字段,包含机构/分支机构的邮政信箱号和相关邮编。
例如
"邮政信箱 103352, 40024"
依据该信箱号,客户可以知悉并使用其对应的完整邮政信箱地址:
邮政信箱 103352
40024,杜塞尔多夫(市)
分支机构信息 任何 70 分支机构信息
该信息是针对该分支机构的免费文本说明,由其所属金融机构提供。暂时仅能通过输入银行代码查看该信息,并仅能在相关金融机构希望将其作为辅助信息提供查看时查看。该信息来源于银行代码字典。
国家名称 任何 70 机构/分支机构国家名称按照ISO 3166标识
ISO国家代码 字母 2 机构/分支机构所在国家的ISO 3166-1 阿尔法-2代码
位置代码 任何类型 1 包含位置(符合银行代码标准:2009第7款位置规定的正式位置)
例如:
• 法国使用的银行代码(BIC)中,巴黎的位置代码为P
• 比利时使用的银行代码(BIC)中,布鲁塞尔的位置代码为B
• 美国使用的银行代码(BIC)中,东海岸的位置代码为3
FIN服务代码 任何类型 60 FIN服务代码(也称为增值服务代码)。仅为包含一个银行代码的记录提供服务代码。
该字段最多可以包含按照字母顺序排列的20个3字符代码。
记录密钥银行字典升级版(BDP) 字母数字 12 文件中银行字典升级版记录的唯一密钥。
A字段 任何 1 备用
B字段 任何 64 备用
C字段 任何 128 备用
D字段 任何Any 256 备用
E字段 任何 11 备用
F字段 任何 12 备用
应用程序界面(API)系统返回XML格式的结果,便于使用各种编程语言和系统解析。

应用程序界面(API)针对银行代码(BIC)搜索回复的SML格式结果示例如下::


<result>
<bicdata>
<row>
<modification_flag>A</modification_flag>
<changed_field>34</changed_field>
<record_key>BP0000004OQQ</record_key>
<previous_record_key>BP00000030XZ</previous_record_key>
<next_record_key/>
<event_type>BIC ADDRESS CHANGED</event_type>
<event_date>20150606</event_date>
<bic8>BARCGB22</bic8>
<branch_bic>XXX</branch_bic>
<bic>BARCGB22XXX</bic>
<record_status>C</record_status>
<operationally_active_record>Y</operationally_active_record>
<subtype_indicator>SUPE</subtype_indicator>
<swift_fin>Y</swift_fin>
<swift_fa>N</swift_fa>
<swift_ia>N</swift_ia>
<legal_name>BARCLAYS BANK PLC</legal_name>
<institution_name>BARCLAYS BANK PLC</institution_name>
<institution_type>FINANCIAL</institution_type>
<entity_type>Legal Entity</entity_type>
<re_street_address_1>1, CHURCHILL PLACE</re_street_address_1>
<re_street_address_2/>
<re_street_address_3/>
<re_street_address_4/>
<re_city>LONDON</re_city>
<re_cps/>
<re_zip_code>E14 5HP</re_zip_code>
<re_pob_number/>
<op_street_address_1>1 CHURCHILL PLACE</op_street_address_1>
<op_street_address_2/>
<op_street_address_3/>
<op_street_address_4/>
<op_city>LONDON</op_city>
<op_cps>LONDON E14 5HP</op_cps>
<op_zip_code/>
<op_pob_number/>
<br_street_address_1/>
<br_street_address_2/>
<br_street_address_3/>
<br_street_address_4/>
<br_city/>
<br_cps/>
<br_zip_code/>
<br_pob_number/>
<branch_information>(ALL U.K. OFFICES)</branch_information>
<country_name>UNITED KINGDOM</country_name>
<iso_country_code>GB</iso_country_code>
<location_code>2</location_code>
<fin_service_codes>EBAERPFINSCOSTGTGT</fin_service_codes>
<record_key_bdp>BD00000006FO</record_key_bdp>
<field_a/>
<field_b/>
<field_c/>
<field_d/>
<field_e/>
<field_f></field_f>
</row>
</bicdata>
<errors/>
</result>




5. 应用程序界面(API)出错

出错时,该界面会返回包含出错信息的一个XML响应。

XML响应中返回的XML标签不包含其他任何字段。

可能返回的所有可能出错信息的说明如下所示:

状态代码 类型 说明
301 账户出错 应用程序界面(API)密钥无效
302 账户出错 订阅过期
303 账户出错 无可用查询
304 账户出错 您还没有进入该应用程序界面(API)
401 输入出错 银行国际代码的标准长度为8或11个字符。
402 输入出错 银行名称无效!搜索的银行名称应包含最少4个字符。
认可字符为a-z, A-Z, 0-9,[空格]!
403 输入出错 国家代码不正确!标准国家代码由2个字母组成,例如:UK、DE和FR。