BankcodeJP API Reference

銀行コード・支店コード検索と、銀行名・支店名の解決を行うAPI

BankcodeJP API は、金融機関・支店の正規データ取得と、ユーザー入力された銀行名・支店名の候補解決を行うAPIです。新規実装では Search API v3 の利用を推奨します。

Quick Start Search API Resolve API β OpenAPI

API構成

Search API

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

Resolve API β

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

Search API 共通仕様

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

OpenAPI

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

やりたいこと別 API選択

やりたいこと	使うAPI	代表エンドポイント
銀行コードから正式な金融機関情報を取得したい	Search API	`GET /v3/banks/{code}`
銀行コード・支店コードから正式な支店情報を取得したい	Search API	`GET /v3/banks/{bankCode}/branches/{code}`
金融機関名・支店名で一覧検索したい	Search API の `filter` または `freeword`	`GET /v3/banks`, `GET /v3/freeword/banks`
ユーザー入力の銀行名・支店名からコード候補を判定したい	Resolve API β	`POST /resolve/v1/bank-branch`
候補を自動確定してよいか、確認が必要かを判定したい	Resolve API β	`decision` を確認

まず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"
  }'

ベースURL

https://apis.bankcode-jp.com

API	主なパス	用途
Search API v3	`/v3/...`	現行推奨の金融機関・支店検索API
Search API v2	`/v2/...`	旧バージョン互換
Search API v1	`/v1/...`	旧バージョン互換
Resolve API β	`/resolve/v1/bank-branch`	銀行名・支店名からコード候補を解決

推奨の読み順

Quick Start
最小のcurl例で疎通とレスポンスイメージを確認します。
Search API
銀行・支店データ取得の基本を確認します。
共通仕様
fields / filter / sort / cursor paging の指定方法を確認します。
Resolve API β
入力値からコード候補を解決する流れを確認します。
OpenAPI仕様
コード生成・schema確認に利用します。

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

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