An important question to ask when dealing with account or transactional data is "How old is it?". An out of date account balance may be useless for your purposes, or you may wish to receive transactions as close to "real-time" as possible.
When you register an app with Akahu we will give your app a default refresh rate. This rate will depend on your app's needs, and may be, for example, every 24 hours. That means that when you call the
/accounts endpoint to view balances, the returned data will be no more than 24 hours old. These schedules can be changed by getting in touch with us.
If your app subscribes to webhooks, you may notice that updates occur more often than the default refresh rate. This is because Akahu refreshes your data as often as possible. The most common case would be that your account is connected to an additional app that refreshes more frequently. For example, if you connect an account to your own once-per-day app, and then proceed to connect the same account to an app that refreshes hourly, your once-per-day app will see updates every hour.
Occasionally the scheduled refreshes don't cut it, and you want to be able to tell Akahu to go and fetch new data. In this situation you can call the
/refresh endpoint to trigger a refresh flow.
Because refresh events can take some time depending on the integration, webhooks are recommended if you use this endpoint, so that you will be notified the moment the refresh flow completes.
/refresh endpoint is rate limited to prevent abuse, meaning it can be called only once every 5 minutes. Note that this limit applies across all apps, so if another app has just called the endpoint, you will receive a rate limit response. Rate limited responses always use the
429 status code.
Updated 5 months ago