Skip to main content
GET
List bank QR institutions
Authenticate with OAuth or a Pirehub API key with the bank-qr:banks scope. Use this endpoint to populate a bank selector before calling the Bank QR generation endpoint. The response includes each bank’s six-digit bin, code, shortName, display name, transfer-support metadata, and an optional public logo URL. Retain one of the first three identifiers as the bank field sent to POST /api/v1/tools/bank-qr. The directory is refreshed from an upstream bank-directory service and falls back to a versioned local snapshot when the upstream directory is unavailable. updatedAt identifies the source snapshot. Cache the response according to Cache-Control; do not poll the endpoint on every form interaction.
A missing or unreachable logo must not prevent bank selection. Provide a local fallback. The transferSupported flag describes compatibility metadata; it is not proof that an account exists or can receive a transfer.
Administrator-issued API keys use the key’s per-minute and monthly request limits. See the Bank transfer QR guide for the complete integration flow, caching guidance, validation rules, and security limitations.

Subscription-backed API keys

Paid self-service keys use shared owner credits and the plan’s per-second and concurrent-job limits. Successful results, including cache hits, consume the configured action cost; errors release the reservation. Video jobs settle at completion. Inspect X-ApiKey-Credit-* and X-ApiKey-RateLimit-*. An optional Idempotency-Key prevents repeated synchronous execution/debits; repeated operations return 409 rather than replaying a response. Job starts use requestId instead. See API plans and idempotency for costs, billing periods, headers, error codes and retry rules.

Authorizations

Authorization
string
header
required

OAuth 2.0 Authorization Code with PKCE, issued by Pirehub's Clerk authorization server. Request only the scopes required by the operation.

Headers

Idempotency-Key
string

Self-service keys only. Owner-scoped operation identifier; reuse after admission returns 409 without another debit or execution. USAGE_CONCURRENCY_EXCEEDED retains no new reservation: wait and retry with the same identifier and payload. No response replay. Video jobs use requestId instead.

Required string length: 1 - 80
Pattern: ^[a-zA-Z0-9_-]+$

Response

The current validated bank directory.

success
boolean
required
data
object
required