Interface BankBranchSearcherOptions

BankBranchSearcherOptions は "searchBankBranches" API に渡すことのできるオプションの集合です。

業態は問い合わせ対象の銀行によって既に定まっているため、 {@link BankSearcherOptions} とは異なり type はありません。

interface BankBranchSearcherOptions {
    match?: v20260801.BankSearchMatchMode;
    q?: string;
    version?: string;
}

Properties

q を名称・カナ読みとどのように照合するか。

デフォルトは "prefix" (前方一致) です。

q?: string

支店の名称およびカナ読みを検索する文字列。

{@link BankSearcherOptions.q} と同じ正規化が行われますが、無視される接尾語は "支店" です。

この項目を指定した場合、銀行自体が存在すれば、該当が0件でも 404 ではなく branches が空の 200 が返ります。

例: "丸の内"

version?: string

どのデータベースのバージョンに対して検索を実行するか。

デフォルトは最新バージョンとなります。

例: "2026-08-01"