Get a refresh intent
Retrieves a refresh intent of a link, using the link’s link_token to authenticate the request.
Autorizaciones
Parámetros de ruta
The id of the refresh intent to retrieve.
Parámetros de consulta
The link_token of the link that holds the refresh intent, obtained when you exchanged the link.
"link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX"
Respuesta
The refresh intent.
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 the refresh did not complete. retryable_error means you can retry the refresh. support_required_error means you need to contact Fintoc support. invalid_credentials_error means the institution rejected the credentials, so the account holder needs to reconnect the link. credentials_locked_error means the institution reports the account as locked, so the account holder needs to unlock the account with the institution before the link can refresh again. null when status is neither failed nor rejected, and when the institution did not report a reason Fintoc can map.
retryable_error, support_required_error, invalid_credentials_error, credentials_locked_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