B BankcodeJP API Reference
Quick Start

最初の実装までの最短手順

APIキーを取得してSearch APIを呼び出すまでの手順です。Resolve API β、Change History API、銀行・支店選択ウィジェットは用途に応じて確認してください。

1. APIキーを取得する

APIキーは BankcodeJP API のダッシュボードから取得できます。アカウント作成後、ダッシュボードにログインし、APIキーを確認してください。

ダッシュボードを開く

2. 環境変数に設定する

export BANKCODEJP_API_KEY='YOUR_API_KEY'

3. 金融機関一覧を取得する

curl -sS "https://apis.bankcode-jp.com/v3/banks?limit=3" \
  -H "x-api-key: ${BANKCODEJP_API_KEY}" | jq

4. 支店情報を取得する

curl -sS "https://apis.bankcode-jp.com/v3/banks/0001/branches/001" \
  -H "x-api-key: ${BANKCODEJP_API_KEY}" | jq

5. filterで検索する

日本語を含むクエリはURLエンコードしてください。curlでは --get と --data-urlencode を推奨します。

curl -sS --get "https://apis.bankcode-jp.com/v3/banks" \
  --data-urlencode "filter=hiragana==*みずほ*" \
  --data-urlencode "limit=5" \
  -H "x-api-key: ${BANKCODEJP_API_KEY}" | jq

必要な場合: 銀行名・支店名を解決する

curl -X POST "https://apis.bankcode-jp.com/resolve/v1/bank-branch" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: ${BANKCODEJP_API_KEY}" \
  -d '{
    "bank_name": "みずほ銀行",
    "branch_name": "東京営業部",
    "context": "default"
  }' | jq

decision が auto_confirm の場合は最有力候補を採用できます。needs_review / ambiguous の場合は候補確認フロー、unresolved の場合は入力修正または別手段での確認フローを挟んでください。

必要な場合: Change History APIの疎通を確認する

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

必要な場合: 銀行・支店選択ウィジェットをフォームに追加する

API Keyをブラウザに埋め込まず、Public ClientのPublic Keyを使ってWeb Componentを利用します。

<script src="https://js.bankcode-jp.com/widgets/bank-branch-selector/v1/bank-branch-selector.js"></script>

<bankcodejp-bank-branch-selector
  public-key="YOUR_PUBLIC_KEY"
  name-prefix="bank_account"
  display-mode="dialog"
  search-mode-switch="fallback">
</bankcodejp-bank-branch-selector>

<script>
  document
    .querySelector("bankcodejp-bank-branch-selector")
    .addEventListener("bcjp:select", (event) => {
      console.log(event.detail);
    });
</script>
  • Public Keyはダッシュボードで作成するPublic Clientから取得します。
  • API Keyはブラウザに埋め込まないでください。
  • 推奨設定では、フォーム上には選択ボタンと選択結果だけを表示し、検索UIはダイアログ内に表示します。
  • 詳細は 銀行・支店選択ウィジェット を参照してください。

次に読むページ