Prerequisites Copied

Ensure a valid Account is linked, as it is a requirement to have a valid account ID for the use of the Refresh endpoints. Refer to the Connect integration documentation for details on requesting the necessary permissions for your specific use case.

Initiating a Data Refresh Copied

Depending on the activity of the record you are trying to refresh, there could be a significant amount of data that may take time to retrieve. For efficiency, refreshing account data is an asynchronous process. After initiating the refresh, you must wait for its completion before retrieving the updated results.

To initiate the refresh, use the Refresh API to start a refresh for an account.

Due to the expensive nature of this operation, we limit the amount you can trigger a refresh of an account to once an hour.

Monitoring the Refresh Status Copied

The balance_refresh or transaction_refresh fields in the account object show the refresh status. When a refresh is initiated, the status changes to pending, then to either succeeded or failed.

• Next Available Refresh: The next_refresh_available_at field indicates when the next refresh can be initiated.

Polling for Updates Copied

Webhook support for refresh completion notifications is not available yet for Connect APIs — but it's on our roadmap.

In the meantime, you can easily check for updates by polling the refresh status endpoint.

Retrieving Updated Account Data Copied

Once the refresh is complete, you can retrieve the updated account data using the Retrieve Account API or List Records for an Account API.