Saltar al contenido principal
GET
List accounts
v1 · Base URL https://api.fintoc.com/v1

Autorizaciones

Authorization
string
header
requerido

Parámetros de consulta

The link_token of the link that holds the accounts to list, obtained when you exchanged the link.

Ejemplo:

"link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX"

page
integer<int32>

Page number to retrieve. Starts at 1.

per_page
string

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

Respuesta

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

id
string
requerido

Unique identifier of the account.

Ejemplo:

"acc_nMNejK7BT8oGbvO4"

object
any
requerido

Type of the object. Always account.

balance
object
requerido

Balance of the account, as reported by the institution. All amounts are in the smallest unit of the account's currency (CLP has no decimals, so amounts are in pesos).

currency
string
requerido

Three-letter ISO 4217 currency code of the account.

Pattern: ^[A-Z]{3}$
Ejemplo:

"CLP"

holder_id
string
requerido

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

Ejemplo:

"111111111"

holder_name
string
requerido

Name of the account holder, as registered at the institution.

Ejemplo:

"Jon Snow"

name
string
requerido

Name of the account.

Ejemplo:

"Cuenta Corriente"

number
string
requerido

Number of the account, as registered at the institution.

Ejemplo:

"9530516286"

official_name
string
requerido

Commercial name of the account type, as defined by the institution.

Ejemplo:

"Cuenta Corriente Moneda Local"

refreshed_at
string<date-time> | null
requerido

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

Ejemplo:

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

type
enum<string>
requerido

Type of the account. Fintoc exposes RUT accounts as sight_account.

Opciones disponibles:
checking_account,
savings_account,
sight_account,
line_of_credit,
credit_card
Ejemplo:

"checking_account"

next_refresh
string<date-time> | null

ISO 8601 timestamp of the next scheduled refresh of the account. Only present when the link has the movements product.

Ejemplo:

"2023-04-06T13:30:00.000Z"

refresh_status
enum<string>

Refresh status of the account. starting means the account was just connected and has not been refreshed yet, refreshing means a refresh is in progress, and interrupted means the account is not currently being refreshed. Only present when the link has the movements product.

Opciones disponibles:
refreshing,
interrupted,
starting
Ejemplo:

"refreshing"

Whether the account no longer belongs to the link (for example, because the institution stopped returning the account). Only present when the link has the movements product.

Ejemplo:

false