Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 5.16 KB

BankConnectionImportDetails.md

File metadata and controls

20 lines (17 loc) · 5.16 KB

# BankConnectionImportDetails

Properties

Name Type Description Notes
bank \OpenAPIWebForm\Client\Model\ImportBankDetails [optional]
bank_connection_name string Custom name for the bank connection [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 parameter of the &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#post-/api/v1/bankConnections/import&#39;&gt;Import a new bank connection</a>&quot; service 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 parameter of the &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#post-/api/v1/bankConnections/import&#39;&gt;Import a new bank connection</a>&quot; service 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 parameter of the &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#post-/api/v1/bankConnections/import&#39;&gt;Import a new bank connection</a>&quot; service in the finAPI Access API. [optional] [default to false]
max_days_for_download int Defines the limit of how many days of the transaction history will be requested from the bank.<br/>This parameter refers to the same parameter of the &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#post-/api/v1/bankConnections/import&#39;&gt;Import a new bank connection</a>&quot; service in the finAPI Access API. [optional] [default to 0]
account_types \OpenAPIWebForm\Client\Model\AccountType[] A set of account types that are considered for the import. If no values is given, then all accounts will be imported.<br/>This parameter refers to the same parameter of the &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#post-/api/v1/bankConnections/import&#39;&gt;Import a new bank connection</a>&quot; service in the finAPI Access API. [optional]
allowed_interfaces string[] Restricts the set of interfaces the end user can import with the web form. If either the `bank.id` or `bank.search` is given, the interfaces of the given bank will be immediately filtered according to the given `allowedInterfaces` parameter. If neither `bank.id` nor `bank.search` is provided within the request, the parameter restricts the bank selection on the web form to the given interfaces. Use with caution in pair with the `accountTypes` parameter as some combinations might end up in a web form not being able to get any accounts from the bank. For example, requesting only `Checking` accounts (parameter `accountTypes`) but limiting interfaces to `WEB_SCRAPER` (parameter `allowedInterfaces`) will most likely result in a web form failing with the `NO_ACCOUNTS_FOR_TYPE_LIST` error code. [optional]
callbacks \OpenAPIWebForm\Client\Model\Callbacks [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&#39;&gt;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!&#39; target='_blank'>Web Form 2.0 Public Documentation</a>. [optional]
allow_test_bank bool Whether the bank search will include the test banks in the search results. When set to false, all test banks will be excluded from the bank search results. [optional] [default to true]

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