Import a new Bank Connection - with Web Form 2.0 (Recommended option)
It is only possible to import a bank connection. There are no services for importing or updating individual accounts. Accounts relate to bank connections, and whenever you import or update a bank connection, all accounts associated with this bank connection are imported/updated.
Step 1 - Request to generate a web form to import a bank connection
Use Import a Bank Connection endpoint in Web Form 2.0:
We recommend setting the
accountTypes parameter and specifying only those account types which apply to your business case. When you provide this parameter, the API will attempt to import only those account types and stop once we have covered every account type that is requested. (BAUSPAREN┃CHECKING┃CREDIT_CARD┃LOAN┃MEMBERSHIP┃SAVINGS┃SECURITY)
We use different protocols (interfaces) for different account types. The end-user will be asked if they would like to loop over the entire workflow until we get all requested account types. To optimize the experience for the end user, provide only those account types that apply to your use case.
Step 2 - Ask the user to log in at the bank and authorize access
As a result of Step 1, the web form is generated. You can find the URL of the web form in the response:
The Web Form has to be presented to the user to authorize access (login at the bank and complete the second-factor authentication procedure).
You have two options on how to present the webform to the user:
Embed the web form into your application. See https://documentation.finapi.io/webform/Embedded-Web-Form-2.0.2124021767.html for more details.
Redirect the user to the Web Form URL in the browser.
There are several branding and customization possibilities available for the web form. Please check out the web form documentation: https://documentation.finapi.io/webform/Whitelabeling.2066612596.html.
Step 3 - Check the status of the Web Form
To retrieve the status of the web form, you can either call the Get a web form service or register to receive a callback once the web form is completed (the callback URL must have been registered during Step 1).
Note that the
bankConnectionId is returned in the response (in the
payload object) to get the status of the bank connection in the next step.
More details are available here.
Step 4 - Check the status of the bank connection
To retrieve the status of the bank connection, get the
bankConnectionId from Step 3 and execute Get a bank connection:
Please beware that it takes some time to download the accounts and transactions from the bank. For more details, please check Post Processing of Bank Account Import/Update.
Step 5 - Get Accounts and Transactions
To query the account data for the imported bank connection, please use the Get and search all accounts endpoint. There are many filtering options available such as by
id, and more. Please refer to the API documentation for all available filters.
You can query transactions for one of the imported accounts/banks or all imported accounts/banks.
Please use the Get and search all transactions endpoint.