BBankcodeJP API Reference
Changelog

リリースノート・バージョン差分

Search API v1/v2/v3、銀行・支店選択ウィジェット、および Resolve API β の変更履歴と主要差分です。新規実装では Search API v3 の利用を推奨します。

現在の推奨

  • Search API の新規実装では Search API v3 を利用してください。
  • Search API v1 / v2 は、既存システムとの互換目的で参照できます。
  • 銀行・支店選択ウィジェットは、銀行・支店選択UIをフォームに組み込むためのWeb Componentです。API Keyをブラウザに埋め込まず、Public ClientのPublic Keyで利用します。
  • Resolve API β は、Search APIとは別系統のAPIとして /resolve/v1/bank-branch で提供します。

Search API リリースノート

Search API v3

2023-10-10 API仕様変更

  • 支店一覧API、支店曖昧検索APIのレスポンスデータに金融機関リソースを追加。
  • 金融機関一覧API、支店一覧API、金融機関曖昧検索API、支店曖昧検索APIのレスポンスデータに含まれる項目名称 data を、それぞれのリソース英名の複数形へ変更。

Search API v2

2023-01-05

  • 曖昧検索APIをリリース。

2022-04-18

  • API v2 をリリース。

2022-04-18 API仕様追加

  • 金融機関API、支店APIにリクエストパラメータ sort を追加し、リソースの並び替えに対応。
  • 金融機関リソースに金融機関種別を追加。
  • 金融機関種別APIを追加。

Search API v1

2020-09-10

  • API v1 をリリース。

Search API バージョン差分

項目 v3 v2 v1
金融機関一覧 banks data data
支店一覧 bank + branches data data
支店取得 bank + branch 配列 配列
金融機関リソース businessTypeCode / businessType あり あり なし

Search API バージョン別仕様

Widget リリースノート

銀行・支店選択ウィジェット v1

2026-06-13

  • Bank Branch Selector Widget v1.0.0 をリリース。
  • メジャー alias /v1/ と固定バージョン /v1.0.0/ の配信を開始。
  • Public Key によるWidget利用、hidden input、Events、Methods、dialog表示に対応。
  • 推奨設定を display-mode="dialog" + search-mode-switch="fallback" として整理。

2026-06-12

  • default-search-modesearch-mode-switch の仕様を追加。
  • フォーム組み込み向けの推奨設定を display-mode="dialog" + search-mode-switch="fallback" として整理。
  • 銀行・支店検索のデフォルトplaceholderを簡潔な文言に更新。

2026-06-09

  • 銀行・支店選択ウィジェットのリファレンスを追加。
  • Public Keyと短期access_tokenを利用するWeb Componentとして提供。
  • inline / dialog 表示、hidden input、bcjp:select / bcjp:error イベントに対応。

Resolve API リリースノート

Resolve API β は、銀行名・支店名の入力から銀行コード・支店コード候補を返し、自動確定可否を decision で返すAPIです。β期間中はベースプラン契約中のAPIキーで利用できます。

Resolve API β の概要

Resolve API β

2026-05-12

  • β リリース