金融機関コード(銀行番号)や支店コード(支店番号)から銀行名や支店名を取得する方法

金融機関コード(銀行番号)や支店コード(支店番号)をから銀行名や支店名を取得したい。調べたところ「金融機関検索WebAPIサービス」のようなAPIが見受けられたが、今回はプロトタイプ版の作成中のため無料で何とかしたかった。「金融機関コード API」だと無料のようなので実装方法をメモ。

サンプル

https://taitan916.info/sample/bank_search/

金融機関コード、視点コードを入力の上、銀行名・支店名取得ボタンをクリックすると下部に戻り値が表示される筈。

金融機関 API

公式サイト

https://bank.teraren.com/

リファレンス

https://bank.teraren.com/doc

実装方法

APIへのアクセス

銀行情報 or 支店情報のどちらを取得するかによってAPIへのアクセス先が以下の通り変わる。

#銀行情報の取得
https://bank.teraren.com/banks/【金融機関コード】.json

#支店情報の取得
https://bank.teraren.com/banks/【金融機関コード】/branches/【支店コード】.json

戻り値例

APIに対してgetJSONやajax等でアクセスし、正常にデータが取得できた場合、以下のような戻り値になる。

銀行情報の取得

{
    "code": "0001",
    "kana": "ミズホ",
    "name": "みずほ",
    "roma": "mizuho",
    "hira": "みずほ",
    "normalize": {
        "name": "みずほ銀行",
        "kana": "ミズホギンコウ",
        "roma": "mizuho ginkou",
        "hira": "みずほぎんこう"
    },
    "created_at": "2025-03-23T21:20:04.000Z",
    "updated_at": "2025-03-23T21:20:04.000Z"
}

支店情報の取得

{
    "code": "001",
    "kana": "トウキヨウ",
    "name": "東京営業部",
    "roma": "toukiyou",
    "hira": "とうきよう",
    "normalize": {
        "name": "東京営業部",
        "kana": "トウキヨウエイギョウブ",
        "roma": "toukiyou eigyobu",
        "hira": "とうきようえいぎょうぶ"
    },
    "created_at": "2025-03-23T21:20:04.000Z",
    "updated_at": "2025-03-23T21:20:04.000Z"
}

その他

サンプルページだと未入力チェックだけだが、サイトに実装する際は桁数や半角数値チェックが必要になる。