v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB

Bank

List Banks

Returns the list of banks Cardda supports. This is global reference data: it is not scoped to a company, returns the same list to every caller, and requires no authentication — this endpoint accepts requests with no Authorization bearer token and no company-id header.

Use each bank's id (a stable slug such as cl_banco_estado) as the bank_id value when creating bank recipients, reading balances, or filtering by bank.

Results are paginated and support the standard _start/_end/_order/_field window, and the response carries X-Total-Count / Content-Range headers.

get/v1/banking/banks

Query parameters

_startinteger

If all the transactions where in an array, this would represent the index of the first item returned in the response

_endinteger

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order'asc' | 'desc'

The order method, which can be ascending or descending

_fieldstring

Example:created_at

The field used to sort, the example illustrates a response that would be sorted by the creation date

idstring

Filter by bank id. Supports the filter DSL, e.g. id={"$in":["cl_banco_estado","cl_banco_bci"]}.

namestring

Filter by bank name. Supports {"$regex":"..."} for partial match.

Response

Paginated list of supported banks.

idstring required

Stable bank identifier (slug), NOT a UUID. Chilean banks are prefixed with cl_, Mexican with mx_, Peruvian with pe_.

namestring required

image_urlstring nullable

URL of the bank's logo. May be null.

created_atstring date-time

updated_atstring date-time

Example response

[
  {
    "id": "cl_banco_santander_chile",
    "name": "Banco Santander",
    "image_url": "https://assets.cardda.com/banks/santander.png"
  }
]