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 actualizará tus cuentas y te notificará con los resultados a través del sistema de webhooks.Cuando la actualización se complete exitosamente, recibirás el evento
account.refresh_intent.succeeded. Después de eso, puedes solicitar inmediatamente a la API de Fintoc los movimientos bancarios más recientes.Cuando la actualización falle o el banco indique que las credenciales no son válidas, recibirás los eventos
account.refresh_intent.failed y account.refresh_intent.rejected respectivamente.
Existen algunas restricciones para solicitar una actualización on-demand. Por ejemplo, no puedes crear un Refresh Intent si hay otro en curso. Además, si el refresh_type es de tipo only_last, debes esperar cinco minutos entre Refresh Intents. Si el refresh_type es de tipo historical, debes esperar sesenta minutos entre Refresh Intents.Autorizaciones
Parámetros de consulta
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 Respuesta
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