| bank_connection_id |
int |
Bank connection identifier |
|
| interface |
BankingInterface |
<strong>Type:</strong> BankingInterface<br/> The interface to use for connecting with the bank. |
|
| source_interface |
BankingInterface |
<strong>Type:</strong> BankingInterface<br/> The source interface that should be used as the source of credentials. Set it to one of already existing bank connection's interfaces and finAPI will try to use the stored credentials of that interface for the current service call. The source interface must fit the following requirements:<br/>- it must have the same set of bank login fields as the main interface (the 'interface' parameter);<br/>- it must have stored values for all its bank login fields.<br/>If any of those conditions are not met - the service will throw an appropriate error.<br/>Note: the source interface is ignored if any login credentials are given. |
[optional] |
| login_credentials |
\OpenAPIAccess\Client\Model\LoginCredential[] |
<strong>Type:</strong> LoginCredential<br/> Set of login credentials. Must be passed in combination with the 'interface' field. |
[optional] |
| store_secrets |
bool |
Whether to store the secret login fields. If the secret fields are stored, then updates can be triggered without the involvement of the users, as long as the credentials remain valid and the bank consent has not expired. Note that bank consent will be stored regardless of the field value. Default value is false. |
[optional] [default to false] |
| skip_positions_download |
bool |
Whether to skip the download of transactions and securities or not. If set to true, then finAPI will download just the accounts list with the accounts' information (like account name, number, holder, etc), as well as the accounts' balances (if possible), but skip the download of transactions and securities. Default is false.<br/><br/>NOTES:<br/>• Setting this flag to true is only meant to be used if A) you generally never download positions, because you are only interested in the accounts list and/or balances, or B) you want to get just the list of accounts in a first step, and then delete unwanted accounts from the bank connection, before you trigger another update with transactions download. This approach allows you to download transactions only for the accounts that you want.<br/>• If you skip the download of transactions and securities during an import or update, you can still download them on a later update (though you might not get all positions at a later point, because the date range in which the bank servers provide this data is usually limited).<br/>• If an account already had any positions imported before an update, and you skip the positions download in the update, then the account's updated balance might not add up to the set of transactions / security positions. Be aware that certain services (like GET /accounts/dailyBalances) may give incorrect results for accounts in such a state.<br/>• If this bank connection is updated via finAPI's automatic batch update, then transactions and security positions (of already imported accounts) <u>will</u> be downloaded in any case!<br/>• For security accounts, skipping the downloading of the securities might result in the account's balance also not being downloaded.<br/>• For Bausparen accounts, this field is ignored. finAPI will always download transactions for Bausparen accounts.<br/> |
[optional] [default to false] |
| load_owner_data |
bool |
Whether to load information about the bank connection owner(s) - see field 'owners'. Default value is 'false'.<br/><br/>NOTE: This feature is supported only by the WEB_SCRAPER interface. |
[optional] [default to false] |
| account_types |
AccountType[] |
|
[optional] |
| account_references |
\OpenAPIAccess\Client\Model\AccountReference[] |
<strong>Type:</strong> AccountReference<br/> List of accounts for which access is requested from the bank. It must only be passed if the bank interface has the DETAILED_CONSENT property set. |
[optional] |
| multi_step_authentication |
MultiStepAuthenticationCallback |
<strong>Type:</strong> MultiStepAuthenticationCallback<br/> Container for multi-step authentication data. Required when a previous service call initiated a multi-step authentication. |
[optional] |
| redirect_url |
string |
Must only be passed when the used interface has the property REDIRECT_APPROACH. The user will be redirected to the given URL from the bank's website after completing the bank login and (possibly) the SCA. |
[optional] |
| max_days_for_download |
int |
This setting defines how much of an account's transactions history will be downloaded whenever a new account is imported. More technically, it depicts the number of days to download transactions for, starting from - and including - the date of the account import. For example, on an account import that happens today, the value 30 would instruct finAPI to download transactions from the past 30 days (including today). The minimum allowed value is 14, the maximum value is 3650. Also possible is the value 0 (which is the default value), in which case there will be no limit to the transactions download and finAPI will try to get all transactions that it can. <br/><br/>Note:<br/>• There is no guarantee that finAPI will actually download transactions for the entire defined date range, as there may be limitations to the download range (set by the bank or by finAPI, e.g. see ClientConfiguration.transactionImportLimitation). <br/>• This parameter only applies to transactions, not to security positions; For security accounts, finAPI will always download all security positions that it can. <br/>• This setting is stored for each interface individually.<br/>• After an interface has been connected with this setting, there is no way to change the setting for that interface afterwards.<br/>• <b>If you do not limit the download range to a value less than 90 days, the bank is more likely to trigger a strong customer authentication request for the user when finAPI is attempting to download the transactions.</b> |
[optional] [default to 0] |