Skip to main content
POST
Create a refresh intent
Fintoc actualiza tus cuentas y envía los resultados mediante el sistema de webhooks.
Cuando Fintoc completa la actualización, recibes el evento account.refresh_intent.succeeded. Luego puedes solicitar los movimientos bancarios más recientes a la API de Fintoc.
Si la actualización falla o el banco informa que las credenciales no son válidas, recibes el evento account.refresh_intent.failed o account.refresh_intent.rejected, respectivamente.
Fintoc limita la frecuencia con la que puedes solicitar una actualización bajo demanda. No puedes crear un refresh intent mientras haya otro en curso. Si refresh_type es only_last, espera cinco minutos entre refresh intents. Si refresh_type es historical, espera 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 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.

Opciones disponibles:
retryable_error,
support_required_error,
invalid_credentials_error,
credentials_locked_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