Skip to main content
GET
Listar cuentas bancarias
Las cuentas bancarias de las empresas conectadas a tu integración, con los saldos tal como quedaron en la última lectura. Es una lista plana: filtras por empresa o por conexión en vez de navegar por ellas.

Permiso

Necesitas una API key con el permiso banking:read escrito en ella. El comodín * no lo concede: los saldos son de un tercero y no salen por una key que nunca pidió verlos. Sin él, 403 con código banking_permission_required.

Filtros

Un valor fuera de ese vocabulario responde 400 con code: parameter_invalid y param con el filtro culpable. page y page_size (tope 200) paginan; ?fields=id,balances recorta cada cuenta a esos campos.

Lo que trae cada cuenta

  • type y subtype son estables aunque cada banco nombre sus productos a su manera. Cuando Tupana no reconoce el producto, subtype viene null.
  • number_mask son los últimos 4 dígitos. El número completo nunca sale por la API.
  • balances son números: enteros en CLP, con decimales en otras monedas. current es el saldo contable, available el disponible y limit el cupo (tarjetas y líneas). En una tarjeta, current es lo adeudado.
  • balances.refreshed_at es la última lectura del banco. El GET nunca toca al banco: la frescura la define el ciclo de sincronización de Tupana, no tus llamadas.
  • credit viene null hoy. Con las tarjetas traerá período de facturación, vencimiento y pago mínimo.
  • status es open mientras la cuenta sigue en la conexión y removed_from_connection cuando el banco dejó de listarla. Sus movimientos se conservan.
Cada lectura queda registrada con tu API key y la cuenta consultada. Es lo que permite responder al titular de la cuenta qué integraciones la han visto.

Authorizations

Authorization
string
header
required

API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)

Query Parameters

company_id
string

Solo las cuentas de esa empresa.

Example:

"ment_3672486436546233854"

connection_id
string

Solo las cuentas que alimenta esa conexión.

Example:

"cred_9Pq5028174639201"

type
enum<string>
Available options:
depository,
credit
subtype
enum<string>
Available options:
checking,
savings,
sight,
credit_card,
line_of_credit
status
enum<string>
Available options:
open,
removed_from_connection
page
integer
default:1
page_size
integer
default:50
Required range: x <= 200
fields
string

Campos a devolver, separados por coma. id siempre va.

Response

Cuentas bancarias

data
object[]
meta
object