BIC / SWIFTコード検証API

ソフトウェアにBIC検証APIを統合する方法

1. BIC検証APIとは何ですか?

電信送金を処理し、IBAN関連の取引を処理するとき、正しいSWIFT / BICコードを提供することは、正常に支払いを行うのに不可欠です。
当社は、S.W.I.F.T SCRLから公式のBICディレクトリをライセンスして、BICを自動的に検証するための強力で簡単な方法を提供しています。このサービスでは、内部目的のためにソフトウェアにBICコードディレクトリ検索を組み込むことができます。

BIC検証APIにはSWIFTRefデータがあります。 S.W.I.F.T.SCRLの許可を得て使用しているBICデータです。データベースの権利を保有しています。 2019

2. 機能

BIC検証APIの主な機能:

  • BICに基づいて銀行に関する情報を取得します。
  • 銀行名と国の一部でBICディレクトリを検索します。
  • BICディレクトリで履歴記録を検索します。
  • 統合を容易にするために、完全なAPI応答と簡略化されたAPI応答の両方を使用します。


3. APIの使い方

BIC検証APIはRESTベースで、単純なHTTP GETまたはPOST要求をサポートしています。

許容されるパラメータは以下の表のとおりです。

フィールド名 長さ タイプ 説明
bic 11 文字列 検索BIC / SWIFTコード。 8文字または11文字にすることができます
bank_name 256 文字列 BICディレクトリ内で検索を実行する銀行名の一部。
country 2 文字列 2文字の国コード銀行名で検索するときに必要です。
api_key 128 文字列 あなたの個人的なAPIキー。
format 4 文字列 返されるデータの形式を指定するために必要です。現在サポートされている値: json, xml
limit 整数 オプション:銀行名で検索するときの結果数を制限するために使用できます。
hist 整数 オプション:銀行とBICの両方の検索用にデータベースからの履歴レコードを表示するために使用できます。
あなたのオンラインポータルの中であなたはあなたのAPIキーと検索要求を保護するために使われるエンドポイントをリクエストするURLを見つけることができます。


4. API XML レスポンス構造

APIレスポンスの XSDスキーマをダウンロードできます。
返されたフィールドの詳細な説明は、下の表にあります。:

フィールド名 タイプ 長さ 必須項目 説明
MODIFICATION FLAG 英字 1 デルタファイル内:
• A (追加)
• M (変更)
• D (削除) フルファイルで:
• A (addition)
CHANGED FIELD 数値 186 × レコードへの変更の結果として、または新しいイベントの結果として変更されたフィールド(またはTAG)を記録します。
1つ以上の列は一連の番号として示され、各番号は前のレコードインスタンスまたは前のイベントから変更された列を表します。
例 "6,7,8,9"
つまり、イベントタイプ、イベント日、BIC8、および支店 BICが
変更されたという意味です。
以下のフィールドは、CHANGED FIELDへの記録から除外されます。:
• RECORD KEY
• CHANGED FIELD
• MODIFICATION FLAG
RECORD KEY 英字 12 ファイル内のレコードの一意のキー
各レコードは、BICライフサイクルにおけるイベントを表します。
一度割り当てられると、RECORD KEYは変更されません。
PREVIOUS RECORD KEY 英字 12 × 以前にリンクされたEVENTのRECORD KEY
すべての関連イベントはリンクされており、この情報を使って見つけることができます。
NEXT RECORD KEY 英字 12 × 次の関連リンクイベントのRECORD KEY
すべての関連イベントはリンクされており、この情報を使って見つけることができます。
EVENT TYPE 英字 32 過去、現在、または将来発生する予定のBICに関連するEVENTまたは変更の説明。
イベントタイプ:
• BIC発行
• BICの期限が切れた
• FINでBICが有効になった
• FAでBICが有効になった
• IAでBICが有効になった
• FINでBICが無効になった
• FAでBICが無効になった
• IAでBICが無効になった
• BICが無効になった
• BICが保留になった
• BICが再び有効になった
• BIC発行された
• BICの法的名称が変更された
• BICの教育機関の名称が変更された
• BICの住所が変更され
• FINのサービスコードが変更された
最終更新日は、BICシーケンスの最後の行(つまり、最新のエントリー)です。
新しいイベントが追加されると、MODIFICATION FLAGとCHANGED
FIELD列は直前の関連イベントで更新されます。
EVENTDATE 英字 8 イベントの日
BIC8 英字 8 BIC (機関、国、およびパーティーのサフィックス) 場所:
• パーティープレフィックス(4文字)
• 国コード(2文字)
• パーティーサフィックス(2文字)
BRANCH BIC 英字 3 8文字のBICに関連付けられているBIC支店ID。支店IDが存在しない場合は、XXXが使用されます。
BIC 英字 11 完全な BIC: 8文字の BIC と支店識別子
RECORD STATUS 英字 1 レコードの状況を示します。:
• [C] = 発行日までのチェーン内の最新のイベントを表す現在の値。[F] utureイベントを除く。

• [H] = イベントチェーンの過去の記録
• [F] = ディレクトリの公開日以降に発生する将来のイベント。前に示された[C] urrentイベントは、[F] utureイベントで指定された日付まで有効です。
未来のイベントの場合、日付は変更がいつ有効になるかを示します。
OPERATIONALLY ACTIVE RECORD 英字 1 同じBICに複数のレコードがあります。このフィールドは、同じBICのどのレコードが操作上アクティブなBICであり、使用する必要があるかを示します。
• [Y] 運用上有効
• [N] 運用上無効
それぞれの固有のBICについて、ACTIVE状況(Y)を示す単一のレコード項目があります。
[H] istoricalステータスのレコードは常に[N]を示します。
[C]の付いたレコードは[Y]または[N]を示します。
[F]が付いているレコードは常に[N]を示します。
SUBTYPE INDICATOR 任意 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に繋がっていない
LEGAL NAME 任意 105 × 機関の正式名
INSTITUTION NAME 任意 105 機関名(公開されている名前)
INSTITUTION TYPE 英字 12 主に金融仲介および/または補助的な金融活動に従事している組織 機関タイプ:
• 金融資産
• 非金融資産
ENTITY TYPE 英字 16 金融エンティティの種類を識別します。:
• 法人
• 支店
• 運用
RE STREET ADDRESS 1 任意 35 × [Registration]番地
RE STREET ADDRESS 2 任意 35 × [Registration] 町名
RE STREET ADDRESS 3 任意 35 × [Registration] 建物、建物名、階
RE STREET ADDRESS 4 任意 35 × [Registration] 地域
RE CITY任意 35 × [Registration] 機関/支店の都市名
RE CPS 任意 90 × [Registration] 所有機関/支店の郡、県、州、またはその他の行政区域
RE ZIP CODE 任意 15 × [Registration] 機関/支店の郵便番号
RE POB NUMBER 任意 35 ×

機関/支店の私書箱番号と関連する郵便番号を含むコンマ区切りのフィールド。

"POB 103352, 40024"
と顧客が入力することで以下の住所のということになります。
私書箱所在地
私書箱 103352
40024, DUESSELDORF (市)

OP STREET ADDRESS 1 任意 35 × [Operational] 番地
OP STREET ADDRESS 2 任意 35 × [Operational] 町名
OP STREET ADDRESS 3 任意 35 × [Operational] 建物、建物名、階
OP STREET ADDRESS 4 任意 35 × [Operational] 地域
OP CITY 任意 35 × [Operational] 機関/支店の都市名
OP CPS 任意 90 × [Operational] 所有機関または支店の郡、県、州、またはその他の行政区域
OP ZIP CODE 任意 15 × [Operational] 機関または支店の郵便番号
OP POB NUMBER 任意 35 × 機関/支店のPOB番号と関連する郵便番号を含むコンマ区切りのフィールド。

"POB 103352, 40024"
と顧客が入力することで以下の住所のということになります。
私書箱所在地
私書箱 103352
40024, DUESSELDORF (市)
BR STREET ADDRESS 1 任意 35 × [Branch] 番地
BR STREET ADDRESS 2 任意 35 × [Branch] 町名
BR STREET ADDRESS 3 任意 35 × [Branch] 建物、建物名、階
BR STREET ADDRESS 4 任意 35 × [Branch] 地域
BR CITY 任意 35 × [Branch] 機関/支店の都市名
BR CPS 任意 90 × [Branch]
所有機関/支店の郡、県、州、またはその他の行政区域
BR ZIP CODE 任意 15 × [Branch]
機関/支店の郵便番号
BR POB NUMBER 任意 35 × 機関/支店のPOB番号と関連する郵便番号を含むコンマ区切りのフィールド。 例
"POB 103352, 40024"
と顧客が入力することで以下の住所のということになります。
私書箱所在地
私書箱 103352
40024, DUESSELDORF (市)
BRANCH INFORMATION 任意 70 ×

支店情報
支店が属する金融機関によって提供される支店の自由に記述できる説明です。当面の間、これはBICのあるエントリーについてのみ、そして関係する金融機関がこの追加の情報を提供したい場合にのみ提供されます。情報はBICディレクトリから供給されます。

COUNTRY NAME 任意 70 ISO 3166に示されている機関/支店の国名
ISO COUNTRY CODE 英字 2 機関/支店の国のISO 3166-1 alpha-2コード
LOCATION CODE 任意 1 場所を含みます(正式にはBIC規格の7桁目:2009)。 例:
• フランス・パリの BICs = P
• ベルギー・ブリュッセルのBICs = B
• アメリカ・東海岸のBICs= 3
FIN SERVICE CODES 任意 60 × FINサービスコード(付加価値サービスコードとも呼ばれる)。サービスコードは、BICを含むレコードに対してのみ提供されています。
このフィールドには、アルファベット順に最大20文字の3文字コードを含むことができます。
RECORD KEY BDP 英字 12 × ファイル内のBank Directory Plusレコードの固有キー
FIELD A 任意 1 × 将来追加される項目
FIELD B 任意 64 × 将来追加される項目
FIELD C 任意 128 × 将来追加される項目
FIELD D 任意 256 × 将来追加される項目
FIELD E 任意 11 × 将来追加される項目
FIELD F 任意 12 × 将来追加される項目
APIシステムはXMLフォーマットで結果を返します。これは、さまざまなプログラミング言語およびプラットフォームで簡単に解析できます。

BIC検索に対するAPIからのXML応答の例は次のようになります。:


<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エラー

エラーが発生した場合、APIはエラーメッセージを含むXML応答を返します。

XMLタグは、XML応答内の他のフィールドなしで返されます。

以下に、返される可能性があるすべてのエラーメッセージの説明を示します。:

Status Code Type Description
301 アカウントエラー APIキーが無効
302 アカウントエラー サブスクリプションが期限切れ
303 アカウントエラー 利用可能なクエリなし
304 アカウントエラー あなたはAPIにアクセスできません。
401 入力エラー SWIFTの長さは8文字または11文字です。
402 入力エラー

銀行名が無効です。銀行検索は4文字以上にする必要があります。使用可能な文字はa?z、A?Z、0?9、[スペース]です。

403 入力エラー 国コードが間違っています。国別コードは2文字です。