Get a bank
GET/v1/banks/:bank_id
Fetch the public directory entry of one bank on the network (any bank, not only your
own). The same attributes as in GET /v1/banks are returned.
Required scope: connector:banks:read.
Errors. 404 Not Found (title bank not found) if no bank has this bank_id.
403 Forbidden (title Forbidden) if the bank exists but is not currently ACTIVE
(for example still onboarding, suspended or terminated).
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 503
The requested bank.
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.
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.
The caller lacks connector:banks:read, or the requested bank exists but is not
ACTIVE.
No bank has this bank_id.
The request was refused because a rate limit was reached (code RATE_LIMITED). No
Retry-After header is sent; retry with exponential backoff.
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.