---
title: "The banks an owner can pick from"
method: GET
path: "/api/v1/banking/banks"
tags: ["Money"]
---

# The banks an owner can pick from

`GET /api/v1/banking/banks`

## Request

- Base URL: `http://localhost:5180`
- URL: `http://localhost:5180/api/v1/banking/banks`
- Auth: API key in cookie `better-auth.session_token`

One row per bank rather than one per service: where both Ponto and Plaid reach the same bank, only the one an owner would be sent to is listed, and which that is has already been decided. `provider` says which service that is, so a row can carry it and a support question has an answer without a database read. The list is refreshed nightly from both services, so this reads our own table and waits on nobody. An empty `q` lists a country’s banks by name, which is what the picker opens on.

## Query parameters

- `q` string
- `country` string
- `limit` number

## Response `200`

The banks to show.

- object
  - `ok` unknown, required
  - `data` object, required
    - `banks` object[], required
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `name` string, required: The bank as the service names it, which is the name the owner recognises.
      - `provider` 'ponto' | 'plaid', required: Which service reads this bank. Shown on the row so it is obvious where picking it leads, and which of the two to look at when a connection misbehaves.
      - `country` string, required
      - `logoUrl` string, nullable, required: Ponto serves a URL and Plaid a data URI; both are safe in an img src.
      - `bic` string, nullable, required
      - `primaryColor` string, nullable, required
      - `status` string, nullable, required
      - `deprecated` boolean, required: The service is withdrawing it, so it is worth saying before an owner picks it.
      - `oauth` boolean, required: The bank takes the owner to its own page to authorise.
      - `consentDays` number, nullable, required: How long the bank’s permission lasts, where the service says.
    - `anyProvider` boolean, required
  - `meta` object, required
    - `requestId` string, required: Echoed in the x-request-id header. Quote it in a bug report.

---

[API](https://skmtc.dev/dardaris/apis/dardaris-api.md) · [All operations](https://skmtc.dev/dardaris/apis/dardaris-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dardaris/apis/dardaris-api/revisions/4aff33835c73?raw)