...
API parameter
accountTypes
- We urge customers to utilize the parameter and specify only those account types which apply to their business case. When you provide this parameter, the API will attempt to import only those accounts 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.
API parameter
importNewAccounts
bankConnectionUpdate end point - As mentioned in the API documentation, the update a bank connection end point will serve multiple purposes. Hence, configure the end point with the correct parameters accordingly.API parameter
importNewAccounts
: Only when your end users would like to ADD new accounts to an existing bank connection, use the parameter,importNewAccounts
for updates. To ensure the best user experience, you can use the API parameteraccountTypes
with it, just like you do with the import a bank connection end point. Link this API call(with the specific parameter) to the trigger on your web site or app, where you allow users to add new accounts to their portfolio overviewAPI parameter
editSavedSettings
- If you want to force the web form to go through the entire flow, in order to allow the end user to change the saved settings, use this parameter. For example, for end users who might have changed their online banking credentials, and would like to update the new credentials in our database as well.Using neither of the above parameters would update only existing accounts (and their transactions, balances, status) to have the latest snapshot like in Online Banking.