Saltar al contenido principal
GET
Get a refresh intent
v1 · Base URL https://api.fintoc.com/v1

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

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.

Ejemplo:

"link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX"

Respuesta

The refresh intent.

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