List banks

GET 
/v1/banks

List the banks on the network that are currently ACTIVE, including your own. Banks in any other status (for example still onboarding, suspended or terminated) are not returned. Use this directory to find a counterparty's bank_id and BIC.

Only public directory attributes are returned for each bank: short_name, display_name, description (when set), country_code, bic_swift_code and status. Nothing about another bank's accounts, balances or configuration is exposed here.

Required scope: connector:banks:list.

Order. Ascending by bank_id.

Request

Responses

200

One page of active banks.

400

The request is malformed: invalid JSON syntax, an invalid path or query parameter, a missing required header such as Idempotency-Key, or a single field that fails its own format rule. Fix the request before retrying; retrying it unchanged fails again.

401

The bearer token is missing, malformed, expired, signed by an unknown key, or was not issued by the platform IAM for the Lyriq Connector. Obtain a new token and retry. See the Authentication section.

403

The token is valid but may not perform this request: it lacks the required scope, has no bank membership, needs an x-dan-bank-id header to choose between several memberships, names a bank in x-dan-bank-id it has no membership for, or the caller's bank is suspended or terminated. A new token with the same configuration fails the same way. See the Authentication section.

429

The request was refused because a rate limit was reached (code RATE_LIMITED). No Retry-After header is sent; retry with exponential backoff.

503

The request could not be served right now. Either the network is not fully operational (OUTBOUND_HALTED or READ_ONLY: mutations are refused while read endpoints keep working; OPERATIONAL_STATE_UNKNOWN: the state could not be determined), or a platform dependency is temporarily unavailable. No Retry-After header is sent; retry later with backoff. When retrying a mutation, reuse the same Idempotency-Key and body.