| bank_connection_id |
int |
Bank connection identifier. |
|
| import_new_accounts |
bool |
Whether new accounts that have not yet been imported will be imported or not.<br/><br/>By setting this parameter to true, we will try to get new accounts the user might have at the bank. The user will have a possibility to stop the process once he finds the accounts he is interested in have been imported. The set of newly imported accounts can be limited by using "accountTypes" parameter.<br/><br/><strong>NOTE:</strong> This parameter is deprecated. Please use <code>importNewAccountsMode</code> in the future. Not setting or setting this parameter to <code>false</code> is the same as not setting or setting <code>importNewAccountsMode=SKIP</code>. Setting this parameter to <code>true</code> is the same as setting <code>importNewAccountsMode=CONDITIONAL</code>. |
[optional] [default to false] |
| import_new_accounts_mode |
string |
This parameter defines how we should deal with new accounts that the user might have at the bank but which have not gotten imported yet.<br/>The user will be able to stop the process once he finds his relevant accounts imported. The set of newly imported accounts can get limited also by using the "accountTypes" parameter.<br/><br/><strong>Import new accounts mode:</strong><br/>• <code>SKIP</code> - no new accounts will get imported;<br/>• <code>CONDITIONAL</code> - For the <code>XS2A</code> interface new accounts will get imported only if the stored consent supports this capability (see: <code>consent.supportsImportNewAccounts = true</code> in Access). For the other interfaces, new accounts will always get imported.<br/>• <code>FORCED</code> - For the <code>XS2A</code> interface, the stored consent will get deleted before the update is triggered, in case it doesn't support importing new accounts. For the other interfaces, new accounts will always get imported.<br/><br/><strong>NOTE:</strong> No matter the option chosen, a web form can still be generated in the background. |
[default to 'SKIP'] |
| account_types |
\OpenAPIWebForm\Client\Model\AccountType[] |
It defines the account types to be added on the bank connection. If no value is given, then all new available accounts will be imported.<br/>Ignored if <code>importNewAccountsMode=SKIP</code> or <code>importNewAccounts</code> is set to false and active otherwise.<br/>This parameter refers to the same parameters of "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/update'>Update a bank connection</a>" and "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/connectInterface'>Connect a new interface</a>" services in the finAPI Access API. |
[optional] |
| allowed_interfaces |
string[] |
Restricts the set of interfaces the end user can update and/or connect with the web form: if given, only these interfaces will be updated or considered for offering to the end user to connect (if connecting new interfaces is requested by the `importNewAccountsMode` parameter), as if other interfaces wouldn't exist for the given bank connection and the linked bank. Please note that if interfaces already connected to the bank connection are filtered out after applying this parameter and there are still interfaces that can be connected, the web form will immediately start in the "connect" mode, without asking the end user whether the connection should take place (comparing to the flow when no `allowedInterfaces` is provided). For example, if the bank connection already has `XS2A` interface connected, and you call this service with the `allowedInterfaces` set to `FINTS_SERVER`, the web form - once opened by the end user - will immediately start with connecting the `FINTS_SERVER` interface (assuming `FINTS_SERVER` is supported by the linked bank). |
[optional] |
| skip_balances_download |
bool |
Whether to skip the download of balances or not. May only be set to true if <code>skipPositionsDownload</code> is also true. <br/>This parameter refers to the same parameters of "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/update'>Update a bank connection</a>" and "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/connectInterface'>Connect a new interface</a>" services in the finAPI Access API. |
[optional] [default to false] |
| skip_positions_download |
bool |
Whether to skip the download of transactions and securities or not.<br/>This parameter refers to the same parameters of "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/update'>Update a bank connection</a>" and "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/connectInterface'>Connect a new interface</a>" services in the finAPI Access API. |
[optional] [default to false] |
| load_owner_data |
bool |
Whether to load information about the bank connection owner(s).<br/>This parameter refers to the same parameters of "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/update'>Update a bank connection</a>" and "<a target='_blank' href='https://docs.finapi.io/?product=access#post-/api/v1/bankConnections/connectInterface'>Connect a new interface</a>" services in the finAPI Access API.<br/><strong>NOTE:</strong> This feature is supported only by the WEB_SCRAPER interface. |
[optional] [default to false] |
| manage_saved_settings |
\OpenAPIWebForm\Client\Model\ManageSavedSettings[] |
If users have stored bank credentials or their preferred SCA procedure in finAPI, then each time it is necessary, the web form will automatically apply the saved settings. This field will force the web form to be presented. Depending on the value you provide in the API, the end-user will have the possibility to provide new credentials, decide if he wants to store the new credentials in finAPI or delete the stored SCA procedure. He might also be able to save a different SCA procedure as preference if the workflow requires it. Use this parameter, for example, if a previous update failed because of invalid credentials, or you want to allow the end-user to reset his preferred SCA method.<br/><br/><strong>Manage saved settings:</strong><br/>• <code>CREDENTIALS</code> - the end user can edit his stored credentials;<br/>• <code>DEFAULT_TWO_STEP_PROCEDURE</code> - the end user can edit his stored default two step procedure. |
[optional] |
| callbacks |
\OpenAPIWebForm\Client\Model\TaskCallbacks |
|
[optional] |
| profile_id |
string |
The profile to be applied to the web form.<br/>This will overwrite the default profile, if such a profile exists. |
[optional] |
| redirect_url |
string |
The URL where the end-user will be redirected to after completing the bank login and (possibly) the SCA on the bank's website. Must always be provided by mandators with <code>FULLY_LICENSED</code> or <code>AISP</code> license type, and may not be provided by mandators with other license types. Find more info in the <a target='_blank' href='https://documentation.finapi.io/webform/Licensed-customers-using-the-Web-Form.2832302195.html'>Web Form 2.0 Public Documentation</a>.<br/><br/><strong>NOTE:</strong> Please note that this URL is used during the bank authentication flow. If you would like to provide a URL to which the end user will get redirected at the <strong>end of the web form flow</strong>, please check out the <a href='https://documentation.finapi.io/webform/For-best-results!.2477654019.html#Forbestresults!-Enhanceend-userexperience!' target='_blank'>Web Form 2.0 Public Documentation</a>. |
[optional] |
| user_metadata |
\OpenAPIWebForm\Client\Model\UserMetadata |
|
[optional] |