金融機関検索
金融機関コード、金融機関名、読み、種別から検索できます。
Search API
金融機関・支店マスタを素早く検索。
銀行、信用金庫、信用組合、労働金庫、農協などの金融機関情報と支店情報をAPIで検索できます。
金融機関コード、支店コード、名称、読み、金融機関種別などを利用でき、 金融機関選択UIや支店検索機能を短期間で実装できます。
Endpoints
GET /v3/banks
GET /v3/banks/{bank_code}
GET /v3/banks/{bank_code}/branches
GET /v3/banks/{bank_code}/branches/{branch_code} Features
できること
支店検索
金融機関コード配下の支店情報を検索できます。
支店コード取得
金融機関コードと支店コードから支店を特定できます。
選択UIへの組み込み
銀行選択・支店選択フォームに組み込めます。
マスタ参照
自社で金融機関マスタを持たず、API経由で参照できます。
更新追従
金融機関・支店情報の更新をAPI側で吸収できます。
Demo
金融機関・支店選択UIの例
Search APIを使うと、金融機関選択・支店選択のUIを実装できます。フォームへの組み込みイメージをブラウザ上で確認できます。
Playground
Search API Playground
ブラウザ上で検索条件を変えながら、Search APIのレスポンスをその場で確認できます。
この画面ではデモ用のAPIキーで実際のレスポンスを確認できます。
本番利用時は、ダッシュボードで発行したAPIキーを利用してください。
GET /v3/banks
{
"banks": [
{
"code": "0001",
"name": "みずほ銀行",
"hiragana": "みずほぎんこう"
}
]
} Try API
curlでSearch APIを試す
ブラウザ上の Playground はデモ用APIキーで動作します。
curlで試す場合は、ダッシュボードで発行したご自身のAPIキーを ${BANKCODEJP_API_KEY} に設定してください。
金融機関一覧
curl -s "https://apis.bankcode-jp.com/v3/banks?limit=10" \
-H "X-API-KEY: ${BANKCODEJP_API_KEY}"金融機関コードで取得
curl -s "https://apis.bankcode-jp.com/v3/banks/0001" \
-H "X-API-KEY: ${BANKCODEJP_API_KEY}"支店一覧
curl -s "https://apis.bankcode-jp.com/v3/banks/0001/branches?limit=10" \
-H "X-API-KEY: ${BANKCODEJP_API_KEY}"支店コードで取得
curl -s "https://apis.bankcode-jp.com/v3/banks/0001/branches/001" \
-H "X-API-KEY: ${BANKCODEJP_API_KEY}"filter例
curl -s "https://apis.bankcode-jp.com/v3/banks?filter=hiragana==*みずほ*&limit=10" \
-H "X-API-KEY: ${BANKCODEJP_API_KEY}"filter queryでは、名称・読み・コードなどを条件に検索できます。 詳細な指定方法はAPIリファレンスをご確認ください。
Response
レスポンス例
金融機関レスポンス例
{
"data": [
{
"bank_code": "0001",
"bank": "みずほ銀行",
"bank_full_hira": "みずほぎんこう"
}
],
"limit": 10,
"nextCursor": "..."
}支店レスポンス例
{
"data": [
{
"bank_code": "0001",
"branch_code": "001",
"branch": "東京営業部",
"branch_full_hira": "とうきょうえいぎょうぶ"
}
],
"limit": 10,
"nextCursor": "..."
} Spec
API仕様特徴
Search APIは、金融機関・支店情報を検索しやすいJSON APIとして提供しています。 選択UI、管理画面、サーバサイド処理のいずれにも組み込みやすい仕様です。
- JSONレスポンス
- APIキー認証
- HTTP/2 over TLS
- CORS対応
- RSQLベースのfilter query
- cursor based pagination
FAQ
Search APIの導入前に確認したいこと
検索条件、データ更新、支店コードの扱いなど、Search APIに関するよくある質問をまとめています。
Start