Saltar al contenido principal
GET
List links
v1 · URL base https://api.fintoc.com/v1
CuentasEl campo accounts es null cuando listas links. Para obtener las cuentas de un link, envía una solicitud al endpoint Obtener link con el link_token que recibiste al intercambiar el link.
PaginaciónLa API pagina los links y devuelve 30 links por página de forma predeterminada. Consulta Paginación para obtener más información. Incrementa el parámetro de consulta page para obtener los links restantes.

Autorizaciones

Authorization
string
header
requerido

Parámetros de consulta

status
enum<string>

If present, Fintoc returns only links with this status.

Opciones disponibles:
active,
inactive,
login_required
page
integer<int32>

Page number to retrieve. Starts at 1.

per_page
string

Number of links per page. Defaults to 30. The maximum is 300.

Respuesta

Paginated list of links. The Link and X-Total-Count headers carry the pagination information.

id
string
requerido

Unique identifier of the link.

Ejemplo:

"link_nMNejK7BT8oGbvO4"

object
any
requerido

Type of the object. Always link.

accounts
object[] | null
requerido

Bank accounts of the link. Included when retrieving or exchanging a single link; null when listing or updating links.

active
boolean
requerido

Whether the link is active. Fintoc does not refresh inactive links. Deactivating a link stops refreshes but does not revoke the link_token's access to already-collected data.

Ejemplo:

true

created_at
string<date-time>
requerido

ISO 8601 timestamp of when the link was created.

Ejemplo:

"2020-04-22T21:10:19.254Z"

holder_id
string
requerido

Tax identifier of the account holder, without dots or hyphens (RUT in Chile, RFC in Mexico).

Ejemplo:

"111111111"

holder_type
enum<string>
requerido

Whether the account holder is an individual or a business.

Opciones disponibles:
individual,
business
Ejemplo:

"individual"

institution
object
requerido
last_time_refreshed
string<date-time> | null
requerido

ISO 8601 timestamp of the link's last refresh. null if Fintoc has never refreshed the link.

Ejemplo:

"2020-11-18T18:43:54.591Z"

Token used to authenticate requests for the link's resources. Only returned when the link is exchanged; null in every other response.

Ejemplo:

"link_nMNejK7BT8oGbvO4_token_sjnNsMyXKJEXAMPLETOKENrnNL1tA8"

mode
enum<string>
requerido

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

Opciones disponibles:
test,
live
Ejemplo:

"live"

refresh_status
enum<string> | null
requerido

Refresh status of the link's accounts. idle means no refresh is in progress, refreshing means every account is refreshing, partially_refreshing means only some accounts are refreshing, and interrupted means no account is currently refreshing.

Opciones disponibles:
idle,
refreshing,
interrupted,
partially_refreshing,
null
Ejemplo:

"idle"

status
enum<string>
requerido

Status of the link. login_required means the institution rejected the stored credentials and you must reconnect the link.

Opciones disponibles:
active,
inactive,
login_required
Ejemplo:

"active"

username
string
requerido

Username used to log in at the institution, without dots or hyphens.

Ejemplo:

"111111111"

subscription_id
string

Identifier of the subscription associated to the link. Only present when the link is returned from a subscription exchange.

Ejemplo:

"sub_nMNejK7BT8oGbvO4"