Bank account

List Bank Accounts

Changed on

Returns a paginated list of bank accounts that the current user has access to through their bank keys.

Common Use Cases

Finding Your Company's Bank Account (for sender_id)

To find your company's bank account for making payments:

GET /v1/banking/bank_accounts?rut=771234568

Where 771234568 is your company's RUT.

Filtering by Account Number

To find a specific account by number:

GET /v1/banking/bank_accounts?number=987654321

Filtering by Bank

To list all accounts from a specific bank:

GET /v1/banking/bank_accounts?bank_id=cl_banco_santander_chile

Pagination

Use _start and _end parameters to control pagination:

GET /v1/banking/bank_accounts?_start=0&_end=10

Important Notes

  • You can only see accounts you have authorization to operate through bank keys
  • The id field in the response is what you'll use as sender_id when creating transactions
  • Account balance is updated when transactions are synchronized

Bank IDs Reference

Common Chilean bank identifiers:

  • cl_banco_de_chile - Banco de Chile
  • cl_banco_bci - BCI
  • cl_banco_santander_chile - Santander Chile
  • cl_banco_itau - Itaú
  • cl_banco_bice - BICE
  • cl_banco_scotiabank - Scotiabank
  • cl_banco_security - Banco Security
  • cl_banco_estado - BancoEstado
get/v1/banking/bank_accounts

Request

  • Base URL
    https://api.cardda.com
  • Auth
    HTTP bearer

Query parameters

_startinteger

Starting index for pagination (0-based)

_endinteger
Example:25

Ending index for pagination (exclusive)

_order'ASC' | 'DESC'
Example:DESC

Sort order (ASC or DESC)

_fieldstring
Example:created_at

Field to sort by

idstring

Filter by bank account UUID. Use id={"$in":["...","..."]} for batch lookups — the second-most-common shape in production traffic after holder_id.

numberstring
Example:987654321

Filter by account number (exact match)

rutstring
Example:771234568

Filter by RUT of the account holder. This is typically your company's RUT. Format: Include only numbers and verification digit (e.g., 771234568)

bank_idstring
Example:cl_banco_santander_chile

Filter by bank identifier

account_type'corriente' | 'vista' | 'ahorro' | 'clabe' | 'yape'
Example:corriente

Filter by account type. corriente / vista / ahorro are the Chilean types, clabe is Mexico (STP) and yape is Peru (BCP). A bare value is an exact match.

holder_idstring uuid
Example:123e4567-e89b-12d3-a456-426614174000

Filter by holder (Person) UUID

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 (unresolved $ref)

Response

Paginated list of bank accounts. The response includes metadata headers:

  • Content-Range: Indicates the range of items returned (e.g., 0-9/45)
  • X-Total-Count: Total number of accounts available
idstring uuid required
balanceinteger nullable

The account balance, in the currency's minor unit, as Cardda read it the last time it synced the account with the bank.

This field is not included in every response that uses this schema. Only GET /v1/banking/bank_accounts, GET /v1/banking/bank_accounts/{bank_account_id} and the payroll-level sender (Bank_payroll.sender) of each row in GET /v1/banking/bank_payrolls/ (the account the payroll is paid from, not the sender of its transactions) return it, and only if the company that holds the account turned on "Mostrar el saldo y las inversiones" in its company settings (Configuración de la empresa). When that setting is off, the balance key is omitted entirely (it is not sent as null, which in this API means something else: "we have never read this account").

Everywhere else this schema is reused — Bank_transaction.sender and Bank_key_filtered.accounts — the key is always omitted, regardless of that setting: there the account identifies where the payment comes from, it does not report its funds. An integration that needs the balance should read it from GET /v1/banking/bank_accounts.

holder_idstring uuid nullable

UUID of the Person (company or counterpart) that owns the account.

bank_idstring

Bank identifier, e.g. cl_banco_de_chile, mx_stp, us_mercury.

typestring

STI subclass, bank-specific (e.g. Banking::Cl::BancoDeChile::Account).

numberstring required
rutstring required
emailstring
namestring
account_type'corriente' | 'vista' | 'ahorro' | 'clabe' | 'yape' nullable

Chilean account types are the following:

  • 'corriente'
  • 'vista'
  • 'ahorro'

Mexican account types are the following:

  • 'clabe'

Peruvian account types are the following:

  • 'yape'

For more details check the guide.

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "bank_id": "cl_banco_de_chile",
    "type": "Banking::Cl::BancoDeChile::Account",
    "number": "0011223344",
    "rut": "77989372K",
    "email": "pagos@cardda.com",
    "name": "pagos cardda",
    "bank_errors": [
      {
        "banking_entity_type": "Banking::BankEntity"
      }
    ]
  }
]

Changes