B BankcodeJP API Reference
BankcodeJP API Reference

銀行・支店情報の取得、候補解決、選択UIを支援

BankcodeJP API は、金融機関・支店の正規データ取得、ユーザー入力された銀行名・支店名の候補解決、銀行・支店選択UIの組み込みを支援します。新規実装では Search API v3 の利用を推奨します。フォームに銀行・支店選択UIを組み込みたい場合は、銀行・支店選択ウィジェットを利用できます。

Quick Start Search API Widget Resolve API β Change History API OpenAPI

提供機能

Search API

金融機関コード、支店コード、金融機関種別、曖昧検索、バージョン情報を取得します。

 Search API共通仕様

fields / filter / sort / cursor paging / URLエンコードなどの共通ルール。

 Bank Branch Selector Widget

銀行・支店選択UIをWeb Componentとしてフォームに組み込めます。

 Resolve API β

入力された銀行名・支店名から、最も可能性の高い銀行コード・支店コード候補を返します。

 Change History API

金融機関・支店データの新設、廃止、名称変更などの変更履歴を確認できます。

 OpenAPI

クライアントコード生成、schema確認、自動検証用の機械可読仕様です。

用途別の選び方

やりたいこと使うもの代表エンドポイント・方式
銀行コードから金融機関情報を取得したいSearch APIGET /v3/banks/{code}
銀行コード・支店コードから支店情報を取得したいSearch APIGET /v3/banks/{bankCode}/branches/{code}
金融機関名・支店名で一覧検索したいSearch API の filter または freewordGET /v3/banks, GET /v3/freeword/banks
銀行・支店選択UIをフォームに組み込みたいBank Branch Selector WidgetWeb Component
ユーザー入力の銀行名・支店名からコード候補を判定したいResolve API βPOST /resolve/v1/bank-branch
銀行・支店データの変更履歴を確認したいChange History APIGET /history/v1/changes

まず1回叩く

APIキーの取得・設定方法は APIキーの取得 を参照してください。

金融機関一覧

curl -sS "https://apis.bankcode-jp.com/v3/banks?limit=3&apikey=YOUR_API_KEY"

支店情報

curl -sS "https://apis.bankcode-jp.com/v3/banks/0001/branches/001?apikey=YOUR_API_KEY"

銀行名・支店名の解決

curl -sS -X POST   "https://apis.bankcode-jp.com/resolve/v1/bank-branch?apikey=YOUR_API_KEY"   -H "content-type: application/json"   --data '{
    "bank_name": "みずほ銀行",
    "branch_name": "東京営業部",
    "context": "default"
  }'

最新のデータ更新情報

curl -sS "https://apis.bankcode-jp.com/history/v1/updates/latest" \
  -H "x-api-key: YOUR_API_KEY" | jq

エンドポイント・配信URL

https://apis.bankcode-jp.com
対象主なパス・配信URL用途
Search API v3/v3/...現行推奨の金融機関・支店検索API
Search API v2/v2/...旧バージョン互換
Search API v1/v1/...旧バージョン互換
Bank Branch Selector Widgethttps://js.bankcode-jp.com/widgets/bank-branch-selector/v1/bank-branch-selector.js銀行・支店選択UIのWeb Component
Resolve API β/resolve/v1/bank-branch銀行名・支店名からコード候補を解決
Change History API/history/v1/...金融機関・支店データの変更履歴を取得

推奨の読み順

  1. Quick Start
    最小のcurl例で疎通とレスポンスイメージを確認します。
  2. Search API
    銀行・支店データ取得の基本を確認します。
  3. Search API共通仕様
    fields / filter / sort / cursor paging の指定方法を確認します。
  4. Widget
    銀行・支店選択UIをフォームに組み込む場合は、Widgetリファレンスを確認してください。
  5. Resolve API β
    入力値からコード候補を解決する流れを確認します。
  6. Change History API
    変更履歴を確認する方法を確認します。
  7. OpenAPI仕様
    コード生成・schema確認に利用します。

このリファレンスの読み方

本文側では、実装時に判断が必要な仕様・代表例・注意点を説明します。バージョン別の完全仕様は Search API v3仕様 / v2仕様 / v1仕様 を参照してください。OpenAPIはコード生成・schema確認用です。