Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 3.28 KB

Account.md

File metadata and controls

25 lines (22 loc) · 3.28 KB

# Account

Properties

Name Type Description Notes
id int Account identifier
bank_connection_id int Identifier of the bank connection that this account belongs to
account_name string Account name
iban string 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.
account_number string (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 string 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.
account_holder_name string Name of the account holder
account_holder_id string Bank's internal identification of the account holder. Note that if your client has no license for processing this field, it will always be 'XXXXX'
account_currency string Account's currency
account_type AccountType <strong>Type:</strong> AccountType<br/> An account type.<br/><br/>Checking,<br/>Savings,<br/>CreditCard,<br/>Security,<br/>Loan,<br/>Pocket (DEPRECATED; will not be returned for any account unless this type has explicitly been set via PATCH),<br/>Membership,<br/>Bausparen<br/><br/>
balance float Current account balance
overdraft float Current overdraft
overdraft_limit float Overdraft limit
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.
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.
interfaces \OpenAPIAccess\Client\Model\AccountInterface[] <strong>Type:</strong> AccountInterface<br/> Set of interfaces to which this account is connected
is_seized bool Whether this account is seized. Note that this information is not received from the bank, but determined by finAPI based on the available account information.

[Back to Model list] [Back to API list] [Back to README]