Batch Update / Push Notification Overview

Batch Update

Push Notifications


Batch Update

With the Batch Update module you can let finAPI update your users' bank connections at regular intervals and fully automated, without the involvement of neither your client application nor your users. 

All that is needed for enabling the Batch Update feature is to set up a configuration for your client applications, where you can specify which kind of bank connections should get updated, and in which interval. You can even have multiple configurations. For instance you could configure to update all bank connections of bank X every 2 hours, all bank connections of bank Y every 4 hours, and all remaining bank connections just once a day. 

A user can still choose for himself whether he wants his bank connections to get updated automatically or not (see flag 'isAutoUpdateEnabled' in the User Resource). Users should know that of course the automatic update only works for the bank connections where they have stored their credentials. finAPI makes sure that no bank connections get updated if the credentials happend to be incorrect on a previous update, in other words: You or your users do not have to be concerned about the Batch Update process locking any accounts. 


  • Currently, if you're not hosting finAPI yourself, the Batch Update configuration must be done by us. Please contact us if you want us to set up the Batch Update for your client applications. If you're hosting finAPI yourself, you will have database scripts and server configurations included in the shipped application, for setting up the Batch Update yourself.


Push Notifications

The Push Notifications module allows your client application to get informed about changes of the users' data, so that your application can itself inform your users about those changes. 

The general way how the Push Notifications feature works is as follows:

  1. A user sets up one or multiple "notification rules" which specify what kind of events he wants to be informed about (please also see How to create notification rules and receive notifications). Note that this means that even though it is the client application that will receive finAPI's notifications (finAPI won't send notifications directly to the users), the notification rules are managed by finAPI on a user-level, not on a client-level. This makes sense as not every user wants to be notified about the same things (or at all).
  2. Whenever a user's accounts/bank connections have been updated during the automatic batch update, finAPI will analyze the result of the update (e.g. Was it successful? What new transactions have been downloaded for which accounts? Etc.), and check if the user has set up notification rules that are "interested in" the changes that occurred in the user's data.
  3. For any rule that "matches" with the result of the update, a notification message will be sent by finAPI to the client application (more precisely: To a specific callback URL that the client application has set up for the respective notification rule when creating it - see the new settings in the Client Configuration Resource).
  4. The client application receives the notifications from finAPI, processes them, and forwards the desired information to the respective user (The exact contents of the notification messages that finAPI sends to the client application depend on the type of notification; more details about this in the API documentation - see section 'Notification Rules').

Of course a user can edit his notification rules at any time, by deleting existing rules or creating new ones. Also, finAPI provides a service to get and search notification rules, which allows you to implement a user-friendly interface for the notifications configuration in your client application.


  • The user creates a new notification rule (NEW_ACCOUNT_BALANCE) after importing a bank connection. Then a new transaction could be triggered to assert that the push notification (NEW_ACCOUNT_BALANCE) was successfully triggered.
  • The user creates a new notification rule (CATEGORY_CASH_FLOW) only for an account id "1234" and category "333". Then the push notification will be triggered only when a transaction in this account with the specific category is triggred.
  • The user creates a new notification rule (HIGH_TRANSACTION_AMOUNT) for a specific threshold. Then the push notification will be triggered whenever a new transaction with an absolute amount higher than or equals to the defined 'absoluteAmountThreshold' is imported during an automatic update.

For further information also see How to create notification rules and receive notifications.

If you have questions or suggestions about these features, please contact our support team.



Article is closed for comments.
Powered by Zendesk