Create a refresh intent
Creates a refresh intent for a link, using the link’s link_token to authenticate the request. Unless the institution requires multi-factor authentication, the refresh starts asynchronously and Fintoc notifies the result through webhooks. Your organization needs the on demand refresh policy, and Fintoc rate limits consecutive refreshes (5 minutes between only_last refreshes, 60 minutes between historical ones).
v1 · Base URL https://api.fintoc.com/v1
Fintoc will update your accounts and notify you with the results through the webhook system.When the update is completed successfully, you will receive the event
account.refresh_intent.succeeded. After that, you can immediately request the Fintoc API for the newest bank movements.When the update fails or the bank indicates that the credentials are invalid, you will receive the events
account.refresh_intent.failed and account.refresh_intent.rejected respectively.
Some restrictions exist to request an on-demand update. For example, you can’t create a Refresh Intent if there is another one in progress. Also, if the refresh_type is of type only_last you must wait five minutes between Refresh Intents. If the refresh_type is of type historical you must wait sixty minutes between Refresh Intents.Authorizations
Query Parameters
The link_token of the link to refresh, obtained when you exchanged the link.
"link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX"
The statement to refresh. only_last retrieves the provisional statement, historical retrieves the historical statement. Defaults to only_last.
only_last, historical Result to force on the refresh intent in test mode. Has no effect in live mode.
succeeded, failed, rejected Response
Refresh intent created. If requires_mfa is null the refresh starts immediately; otherwise complete the multi-factor authentication in the widget with requires_mfa.widget_token.
Unique identifier of the refresh intent.
"ri_2dXqkOKkS9mOvnaW"
Type of the object. Always refresh_intent.
ISO 8601 timestamp of when the refresh intent was created.
"2021-08-23T18:22:46.792Z"
Reason for the failure. retryable_error means you can retry the refresh, support_required_error means you need to contact Fintoc support. null unless status is failed.
retryable_error, support_required_error, null null
Type of the object being refreshed. The refresh intents API always returns link refresh intents.
link, account "link"
Identifier of the object being refreshed.
"link_nzwA3XWYiZkg4ojK"
Present when the institution requires multi-factor authentication to complete the refresh; contains the widget_token needed to resume the flow in the widget. null otherwise. Only included when refreshed_object is link.
Status of the refresh intent. rejected means the institution rejected the stored credentials.
created, waiting_for_action, requires_action, processing_action, rejected, failed, succeeded, canceled "succeeded"
Type of the refresh. only_last fetches the most recent movements, historical fetches the full history of movements.
only_last, historical "only_last"
Number of new movements the refresh fetched. Only present when refreshed_object is account (for example, in webhook payloads).
12