Check the status of an account information refresh task. If the task is not yet completed, the status will be shown as pending.
If the status is completed, then the data is ready to be collected via the Retrieve Financial Data endpoints.
To monitor the status of a refresh task we provide two methods. The preferred approach is to utilise the webhook functionality within the Bud platform where Bud will send a webhook to your configured endpoint when the task completes. Alternatively you can poll this endpoint to retrieve the status of the task.
Please ensure that you either receive a webhook with a status of Completed and result of success or this endpoint returns a status of Completed and result of success before trying to access the Customer's data or initiating another process.
When the task is successful, we include in the response body a metadata.has_new_transactions boolean attribute that tells you if the refresh resulted in storing new data. This attribute must be used to
decide if it's necessary to pull the Customer's data or not.
When the refresh fails, we include the reason of the failure as part of the data.result attribute. We also include the data.sub_tasks[i].reconnect_required boolean attribute that indicates if the consent used to
fetch the data for this customer and provider is no longer valid. If reconnect_required is true, the customer will need to go through the bank account connection flow and the consent will be marked as revoked.
When only a subset of sub tasks fails the main task will be marked as Failed but for each provider where the refresh was successful (result is equal to success) customers data will be updated and available from the Retrieve Financial Data endpoints.
In the case of a partial success you are able to specify the providers body parameter to the Initiate Refresh V2 endpoint to initiate a refresh for the failing provider(s).