| interface |
BankingInterface |
<strong>Type:</strong> BankingInterface<br/> Bank interface. Possible values:<br><br>• <code>WEB_SCRAPER</code> - means that finAPI will parse data from the bank's online banking website.<br>• <code>FINTS_SERVER</code> - means that finAPI will download data via the bank's FinTS interface.<br>• <code>XS2A</code> - means that finAPI will download data via the bank's XS2A interface.<br> |
|
| login_credentials |
\OpenAPIAccess\Client\Model\LoginCredentialResource[] |
<strong>Type:</strong> LoginCredentialResource<br/> Login fields for this interface (in the order that we suggest to show them to the user), with their currently stored values. Note that this list always contains all existing login fields for this interface, even when there is no stored value for a field (value will be null in such a case). |
|
| default_two_step_procedure_id |
string |
The default two-step-procedure for this interface. Must match one of the available 'procedureId's from the 'twoStepProcedures' list. When this field is set, then finAPI will automatically try to select the procedure wherever applicable. Note that the list of available procedures of a bank connection may change as a result of an update of the connection, and if this field references a procedure that is no longer available after an update, finAPI will automatically clear the default procedure (set it to null). |
|
| two_step_procedures |
\OpenAPIAccess\Client\Model\TwoStepProcedure[] |
<strong>Type:</strong> TwoStepProcedure<br/> Available two-step-procedures in this interface, used for submitting a money transfer or direct debit request (see /accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit),or for multi-step-authentication during bank connection import or update. The available two-step-procedures mya be re-evaluated each time this bank connection is updated (/bankConnections/update). This means that this list may change as a result of an update. |
|
| ais_consent |
BankConsent |
<strong>Type:</strong> BankConsent<br/> If this field is set, it means that this interface is handing out a consent to finAPI in exchange for the login credentials. finAPI needs to use this consent to get access to the account list and account data (i.e. Account Information Services, AIS). If this field is not set, it means that this interface does not use such consents. |
|
| last_manual_update |
UpdateResult |
<strong>Type:</strong> UpdateResult<br/> Result of the last manual update of the associated bank connection using this interface. If no manual update has ever been done so far with this interface, then this field will not be set. |
|
| last_auto_update |
UpdateResult |
<strong>Type:</strong> UpdateResult<br/> Result of the last auto update of the associated bank connection using this interface (ran by finAPI's automatic batch update process). If no auto update has ever been done so far with this interface, then this field will not be set. |
|
| user_action_required |
bool |
This field indicates whether the user's attention is required for the next update of the given bank connection interface.<br/>If the field is true, finAPI stops auto-updates of this bank connection interface to mitigate the risk of locking the user's bank account and also of triggering a multi-step authentication that might lead to a notification being sent to the end-user.<br/>If the field is false, the user's attention might still be required for the next bank update, e.g. because of new Terms and Conditions that have to get approved by the user.(this only applies to users whose mandator doesn't have an AIS license)<br/>Every communication with the bank (e.g. updating a bank connection, submitting a money transfer or a direct debit, etc.) can change the value of this flag. If the field is true, we recommend to ask the end-user to trigger a manual update of the bank connection interface (using the 'Update a bank connection' service). If the update completes successfully without triggering a strong customer authentication or results in storing a valid XS2A consent, this flag will switch to false. The logic about determination of the user's attention being required might change in time. Please use this as a convenience function to know, when you have to involve the user in the next communication with the bank. Once the flag switches to false, the bank connection interface will be enabled again for the auto-update (if it is configured). |
|
| 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> |
|