Interface BankBranchSearcherOptions

A BankBranchSearcherOptions stores a set of parameters that will be sent to searchBankBranches API.

Note that, unlike BankSearcherOptions, there is no type here as the category is already determined by the bank being queried.

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

Properties

How q is matched against the names and the readings.

Defaults to "prefix".

q?: string

The text to search the branch names and the kana readings with.

The same normalization as BankSearcherOptions.q applies, except that the suffix being ignored is "支店".

When this is given, an empty result comes back as a 200 with an empty branches rather than a 404, as long as the bank itself exists.

Example: "丸の内"

version?: string

The version of the database that the query has to be performed against.

Defaults to the latest available version.

Example: "2026-08-01"