| id |
int |
Account identifier |
|
| bank_connection_id |
int |
Identifier of the bank connection that this account belongs to |
|
| account_name |
str |
Account name |
[optional] |
| account_number |
str |
(National) account number. Note that this value might change whenever the account is updated (for example, leading zeros might be added or removed). |
|
| sub_account_number |
str |
Account's sub-account-number. Note that this field can change from 'null' to a value - or vice versa - any time when the account is being updated. This is subject to changes within the bank's internal account management. |
[optional] |
| iban |
str |
Account's IBAN. Note that this field can change from 'null' to a value - or vice versa - any time when the account is being updated. This is subject to changes within the bank's internal account management. |
[optional] |
| account_holder_name |
str |
Name of the account holder |
[optional] |
| account_holder_id |
str |
Bank's internal identification of the account holder |
[optional] |
| account_currency |
str |
Account's currency |
[optional] |
| account_type_id |
int |
Identifier of the account's type. Note that, in general, the type of an account can change any time when the account is being updated. This is subject to changes within the bank's internal account management. However, if the account's type has previously been changed explicitly (via the PATCH method), then the explicitly set type will NOT be automatically changed anymore, even if the type has changed on the bank side. <br/>1 = Checking,<br/>2 = Savings,<br/>3 = CreditCard,<br/>4 = Security,<br/>5 = Loan,<br/>6 = Pocket (DEPRECATED; will not be returned for any account unless this type has explicitly been set via PATCH),<br/>7 = Membership,<br/>8 = Bausparen<br/> |
|
| account_type_name |
str |
Name of the account's type |
|
| balance |
float |
Current account balance |
[optional] |
| overdraft |
float |
Current overdraft |
[optional] |
| overdraft_limit |
float |
Overdraft limit |
[optional] |
| available_funds |
float |
Current available funds. Note that this field is only set if finAPI can make a definite statement about the current available funds. This might not always be the case, for example if there is not enough information available about the overdraft limit and current overdraft. |
[optional] |
| last_successful_update |
str |
Timestamp of when the account was last successfully updated (or initially imported); more precisely: time when the account data (balance and positions) has been stored into the finAPI databases. The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time). |
[optional] |
| last_update_attempt |
str |
Timestamp of when the account was last tried to be updated (or initially imported); more precisely: time when the update (or initial import) was triggered. The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time). |
[optional] |
| is_new |
bool |
Indicating whether this account is 'new' or not. Any newly imported account will have this flag initially set to true, and remain so until you set it to false (see PATCH /accounts/<id>). How you use this field is up to your interpretation, however it is recommended to set the flag to false for all accounts right after the initial import of the bank connection. This way, you will be able recognize accounts that get newly imported during a later update of the bank connection, by checking for any accounts with the flag set to true right after an update. |
[default to False] |
| status |
str |
The current status of the account. Possible values are:<br/>• <code>UPDATED</code> means that the account is up to date from finAPI's point of view. This means that no current import/update is running, and the previous import/update could successfully update the account's data (e.g. transactions and securities), and the bank given balance matched the transaction's calculated sum, meaning that no adjusting entry ('Zwischensaldo' transaction) was inserted.<br/>• <code>UPDATED_FIXED</code> means that the account is up to date from finAPI's point of view (no current import/update is running, and the previous import/update could successfully update the account's data), BUT there was a deviation in the bank given balance which was fixed by adding an adjusting entry ('Zwischensaldo' transaction).<br/>• <code>DOWNLOAD_IN_PROGRESS</code> means that the account's data is currently being imported/updated.<br/>• <code>DOWNLOAD_FAILED</code> means that the account data could not get successfully imported or updated. Possible reasons: finAPI could not get the account's balance, or it could not parse all transactions/securities, or some internal error has occurred. Also, it could mean that finAPI could not even get to the point of receiving the account data from the bank server, for example because of incorrect login credentials or a network problem. Note however that when we get a balance and just an empty list of transactions or securities, then this is regarded as valid and successful download. The reason for this is that for some accounts that have little activity, we may actually get no recent transactions but only a balance.<br/>• <code>DEPRECATED</code> means that the account could no longer get matched with any account from the bank server. This can mean either that the account was terminated by the user and is no longer sent by the bank server, or that finAPI could no longer match it because the account's data (name, type, iban, account number, etc.) has been changed by the bank. |
|
| supported_orders |
list[str] |
List of orders that this account supports. Possible values are:<br/><br/>• <code>SEPA_MONEY_TRANSFER</code> - single money transfer<br/>• <code>SEPA_COLLECTIVE_MONEY_TRANSFER</code> - collective money transfer<br/>• <code>SEPA_BASIC_DIRECT_DEBIT</code> - single basic direct debit<br/>• <code>SEPA_BASIC_COLLECTIVE_DIRECT_DEBIT</code> - collective basic direct debit<br/>• <code>SEPA_B2B_DIRECT_DEBIT</code> - single Business-To-Business direct debit<br/>• <code>SEPA_B2B_COLLECTIVE_DIRECT_DEBIT</code> - collective Business-To-Business direct debit<br/><br/>Note that this list may be empty if the account is not supporting any of the above orders. Also note that the list is refreshed each time the account is being updated, so available orders may get added or removed in the course of an account update.<br/><br/> |
|
| clearing_accounts |
list[ClearingAccountData] |
List of clearing accounts that relate to this account |
[optional] |