| id |
int |
Bank identifier.<br/><br/>NOTE: Do NOT assume that the identifiers of banks are the same across different finAPI environments. In fact, the identifiers may change whenever a new finAPI version is released, even within the same environment. The identifiers are meant to be used for references within the finAPI services only, but not for hard-coding them in your application. If you need to hard-code the usage of a certain bank within your application, please instead refer to the BLZ. |
|
| name |
str |
Name of bank |
|
| login_hint |
str |
Login hint. Contains a German message for the user that explains what kind of credentials are expected.<br/><br/>Please note that it is strongly recommended to always show the login hint to the user if there is one, as the credentials that finAPI requires for the bank might be different to the credentials that the user knows from the bank's website.<br/><br/>Also note that the contents of this field should always be interpreted as HTML, as the text might contain HTML tags for highlighted words, paragraphs, etc. |
[optional] |
| bic |
str |
BIC of bank |
[optional] |
| blz |
str |
BLZ of bank |
|
| blzs |
list[str] |
List of BLZs that belong to this bank. NOTE: This field is deprecated and will be removed at some point. Please refer to field 'blz' instead. |
|
| login_field_user_id |
str |
Label for the user ID login field, as it is called on the bank's website (e.g. "Nutzerkennung"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value. |
[optional] |
| login_field_customer_id |
str |
Label for the customer ID login field, as it is called on the bank's website (e.g. "Kundennummer"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value. |
[optional] |
| login_field_pin |
str |
Label for the PIN field, as it is called on the bank's website (mostly "PIN"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value. |
[optional] |
| is_supported |
bool |
Whether this bank is supported by finAPI, i.e. whether you can import/update a bank connection of this bank. |
[default to False] |
| supported_data_sources |
list[str] |
List of the data sources that finAPI will use for data download for this bank. Possible values:</br></br>• <code>FINTS_SERVER</code> - means that finAPI will download data via the bank's FinTS interface.</br>• <code>WEB_SCRAPER</code> - means that finAPI will parse data from the bank's online banking website.</br></br>Note that this list will be empty for non-supported banks. Note also that web scraping might be disabled for your client (see GET /clientConfiguration). When this is the case, then finAPI will not use the web scraper for data download, and if the web scraper is the only supported data source of this bank, then finAPI will not allow to download any data for this bank at all (for details, see POST /bankConnections/import and POST /bankConnections/update). |
|
| pins_are_volatile |
bool |
Whether the PINs that are used for authentication with the bank are volatile. If the PINs are volatile, it means that a PIN is usually valid only for a single authentication, and is then invalidated. If a bank uses volatile PINs, it is strongly inadvisable to store PINs in finAPI, as a stored PIN will not work for future authentications. |
[default to False] |
| location |
str |
Bank location (two-letter country code; ISO 3166 ALPHA-2). Note that when this field is not set, it means that this bank depicts an international institute which is not bound to any specific country. |
[optional] |
| city |
str |
City that this bank is located in. Note that this field may not be set for some banks. |
[optional] |
| is_test_bank |
bool |
If true, then this bank does not depict a real bank, but rather a testing endpoint provided by a bank or by finAPI. You probably want to regard these banks only during the development of your application, but not in production. You can filter out these banks in production by making sure that the 'isTestBank' parameter is always set to 'false' whenever your application is calling the 'Get and search all banks' service. |
[default to False] |
| popularity |
int |
Popularity of this bank with your users (mandator-wide, i.e. across all of your clients). The value equals the number of bank connections that are currently imported for this bank across all of your users (which means it is a constantly adjusting value). You can use this field for statistical evaluation, and also for ordering bank search results (see service 'Get and search all banks'). |
|
| health |
int |
The health status of this bank. This is a value between 0 and 100, depicting the percentage of successful communication attempts with this bank during the latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' means that there was no technical error trying to establish a communication with the bank. Non-technical errors (like incorrect credentials) are regarded successful communication attempts. |
|
| last_communication_attempt |
str |
Time of the last communication attempt with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time). |
[optional] |
| last_successful_communication |
str |
Time of the last successful communication with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time). |
[optional] |