Saltar al contenido

Referencia de API

Objetos

Estos son los objetos que devuelve la API. Todos tienen un id con prefijo y un campo object que indica su tipo. Podemos agregar campos nuevos en cualquier momento: ignora los que no conozcas.

Una conexión autorizada por un titular sobre un banco.

idstring
Identificador con prefijo link_.
objectstring
Siempre link.
institutionobject
Banco de la conexión.idstringId de la institución, por ejemplo bci o sandbox.namestringNombre para mostrar.
holder_typestring
Tipo de titular.individualbusiness
holder_namestring· nullable
Nombre o razón social del titular, si el banco lo informa.
holder_idstring· nullable
RUT del titular sin puntos y con guion, por ejemplo 76123874-4. En cuentas de empresa es el RUT de la empresa.
statusstring
Estado de la conexión (ver tabla).activesyncingcredentials_invalidaction_requirederrordisconnected
status_messagestring· nullable
Explicación del estado en español, apta para mostrar. null cuando todo está bien.
modestring
Modo de la conexión.livetest
allow_mcpboolean
Si la conexión es visible desde el servidor MCP.
last_refreshed_atstring (date-time)· nullable
Última sincronización exitosa.
next_refresh_atstring (date-time)· nullable
Próxima sincronización automática. null si no hay una programada.
created_atstring (date-time)
Cuándo se creó la conexión.
statusSignificadoQué hacer
activeLa conexión funciona y se sincroniza sola.Nada.
syncingHay una sincronización en curso.Espera el webhook link.refreshed.
credentials_invalidEl banco rechazó la clave (la persona la cambió o la bloqueó).Pide a la persona que vuelva a conectar su cuenta.
action_requiredEl banco pide una acción, por ejemplo registrar de nuevo el equipo.Pide a la persona que vuelva a conectar su cuenta.
errorFalló la última sincronización por un problema temporal.Nada: se reintenta sola en unas horas.
disconnectedLa conexión fue revocada y sus credenciales borradas.Crea una conexión nueva si la necesitas.

Ejemplo

{
  "id": "link_9f2c41ab7e05d318",
  "object": "link",
  "institution": {
    "id": "sandbox",
    "name": "Banco de Prueba"
  },
  "holder_type": "business",
  "holder_name": "Panadería La Espiga SpA",
  "holder_id": "76123874-4",
  "status": "active",
  "status_message": null,
  "mode": "test",
  "allow_mcp": true,
  "last_refreshed_at": "2026-11-18T14:02:11.482Z",
  "next_refresh_at": "2026-11-19T14:02:11.482Z",
  "created_at": "2026-11-18T14:02:09.917Z"
}

Account

Una cuenta bancaria de un link.

idstring
Identificador con prefijo acc_.
objectstring
Siempre account.
link_idstring
Link al que pertenece.
numberstring
Número de cuenta según el banco.
namestring
Nombre de la cuenta según el banco, por ejemplo «Cuenta Corriente».
typestring
Tipo de cuenta.checking_accountsight_accountsavings_accountcredit_cardline_of_credit
currencystring
Código ISO 4217. Hoy siempre CLP.
balanceobject
Saldo en pesos enteros.availableinteger· nullableSaldo disponible.currentinteger· nullableSaldo contable.
refreshed_atstring (date-time)
Cuándo se leyó el saldo por última vez.

Ejemplo

{
  "id": "acc_3f9a1c0e5b7d2468",
  "object": "account",
  "link_id": "link_9f2c41ab7e05d318",
  "number": "0012785975",
  "name": "Cuenta Corriente",
  "type": "checking_account",
  "currency": "CLP",
  "balance": {
    "available": 26593700,
    "current": 26638700
  },
  "refreshed_at": "2026-11-18T14:02:11.204Z"
}

Movement

Un abono o cargo de una cuenta.

idstring
Identificador estable con prefijo mov_.
objectstring
Siempre movement.
account_idstring
Cuenta a la que pertenece.
amountinteger
Monto en pesos enteros: positivo para abonos, negativo para cargos.
currencystring
Hoy siempre CLP.
typestring
Dirección del movimiento.inflowoutflow
descriptionstring
Descripción legible del movimiento.
bank_descriptionstring· nullable
Glosa original del banco, sin cambios.
post_datestring (date)
Fecha contable (AAAA-MM-DD).
transaction_datestring (date)· nullable
Fecha en que ocurrió la transacción, si el banco la informa.
counterpartyobject
Contraparte: quién pagó o a quién se pagó. Los campos vienen en null si el banco no los informa.namestring· nullableNombre o razón social.idstring· nullableRUT sin puntos y con guion, por ejemplo 76287005-3.
reference_idstring· nullable
Número de operación del banco.

Ejemplo

{
  "id": "mov_e41b9c07a2d85f36",
  "object": "movement",
  "account_id": "acc_3f9a1c0e5b7d2468",
  "amount": 1315000,
  "currency": "CLP",
  "type": "inflow",
  "description": "Pago de factura de Constructora Valle Central SpA",
  "bank_description": "TRASPASO DE: CONSTRUCTORA VALLE CENTRAL SPA",
  "post_date": "2026-11-18",
  "transaction_date": "2026-11-18",
  "counterparty": {
    "name": "Constructora Valle Central SpA",
    "id": "76287005-3"
  },
  "reference_id": "479249273"
}

Institution

idstring
Código de la institución, por ejemplo bci.
objectstring
Siempre institution.
namestring
Nombre para mostrar.
statusstring
Si se puede conectar en el modo de la llave.availablecoming_soon
holder_typesstring[]
Tipos de titular que acepta.individualbusiness
test_onlyboolean
true para el Banco de Prueba, que solo existe en modo test.

List

Los endpoints que listan devuelven este envoltorio. Ver Paginación.

objectstring
Siempre list.
dataarray
Los elementos de la página.
has_moreboolean
true si hay más elementos después del último de esta página.