Saltar al contenido principal
POST
Create a refresh intent
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

Authorization
string
header
requerido

Parámetros de consulta

The link_token of the link to refresh, obtained when you exchanged the link.

Ejemplo:

"link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX"

refresh_type
enum<string>

The statement to refresh. only_last retrieves the provisional statement, historical retrieves the historical statement. Defaults to only_last.

Opciones disponibles:
only_last,
historical
result_status
enum<string>

Result to force on the refresh intent in test mode. Has no effect in live mode.

Opciones disponibles:
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.

id
string
requerido

Unique identifier of the refresh intent.

Ejemplo:

"ri_2dXqkOKkS9mOvnaW"

object
any
requerido

Type of the object. Always refresh_intent.

created_at
string<date-time>
requerido

ISO 8601 timestamp of when the refresh intent was created.

Ejemplo:

"2021-08-23T18:22:46.792Z"

public_error
enum<string> | null
requerido

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.

Opciones disponibles:
retryable_error,
support_required_error,
null
Ejemplo:

null

refreshed_object
enum<string>
requerido

Type of the object being refreshed. The refresh intents API always returns link refresh intents.

Opciones disponibles:
link,
account
Ejemplo:

"link"

refreshed_object_id
string
requerido

Identifier of the object being refreshed.

Ejemplo:

"link_nzwA3XWYiZkg4ojK"

requires_mfa
object | null
requerido

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
enum<string>
requerido

Status of the refresh intent. rejected means the institution rejected the stored credentials.

Opciones disponibles:
created,
waiting_for_action,
requires_action,
processing_action,
rejected,
failed,
succeeded,
canceled
Ejemplo:

"succeeded"

type
enum<string>
requerido

Type of the refresh. only_last fetches the most recent movements, historical fetches the full history of movements.

Opciones disponibles:
only_last,
historical
Ejemplo:

"only_last"

new_movements
integer

Number of new movements the refresh fetched. Only present when refreshed_object is account (for example, in webhook payloads).

Ejemplo:

12