> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paj.cash/llms.txt
> Use this file to discover all available pages before exploring further.

# Get banks

> Returns the supported banks. Any of the query parameters may be used to narrow the list — code matches exactly, name and country match case-insensitively on a substring. With no parameters every bank is returned.

Returns the banks Paj can pay out to, each with the `code` that the rest of the
API expects. Everywhere a bank is named — [registering an
account](/api-reference/register-bank-account), [creating an offramp
order](/api-reference/create-offramp-order) — it is named by `code`, and this is
where those codes come from.

Called with no query parameters it returns every bank. The three filters narrow
it down and combine:

* **`code`** matches exactly (case-insensitively). Use it to confirm a code you
  already hold is still valid, or to fetch a single bank's name and logo.
* **`name`** matches any bank whose name *contains* the value, case-insensitively
  — `?name=access` finds "Access Bank".
* **`country`** is the short code the bank operates in, e.g. `NG`.

There is no pagination. The full list is a few hundred entries and is returned
in one response.

<Tip>
  Fetch the list once and cache it. Bank codes are stable, and the list changes
  only when Paj syncs new banks from the payout rail — typically a handful of
  times a year. Matching a user's typed bank name against a cached list is much
  faster than calling this per registration.
</Tip>

The `name` filter is a substring match, not a search: it does not correct
spelling or rank results. If you are letting users pick a bank, pull the whole
list and filter it client-side rather than sending every keystroke here.


## OpenAPI

````yaml GET /pub/v2/bank
openapi: 3.0.0
info:
  title: Paj Public API
  description: >-
    Programmatic access to Paj's on/off ramp. Register a Nigerian bank account,
    get

    the on-chain address that pays it, create offramp orders for a specific
    amount,

    and read the live conversion rates.


    Every request must carry an `x-api-key` header. Keys are scoped to a
    business,

    and the rates you receive already have that business's fee applied.
  version: 2.0.0
  contact: {}
servers:
  - url: https://api.paj.cash
    description: Production
security: []
tags: []
paths:
  /pub/v2/bank:
    get:
      tags:
        - Pub V2
      summary: Get banks
      description: >-
        Returns the supported banks. Any of the query parameters may be used to
        narrow the list — code matches exactly, name and country match
        case-insensitively on a substring. With no parameters every bank is
        returned.
      operationId: PubV2Controller_getBanks
      parameters:
        - name: code
          required: false
          in: query
          description: Bank code to match exactly
          schema:
            example: '000016'
            type: string
        - name: name
          required: false
          in: query
          description: Partial, case-insensitive bank name to match
          schema:
            example: access
            type: string
        - name: country
          required: false
          in: query
          description: Country short code the bank operates in
          schema:
            example: NG
            type: string
      responses:
        '200':
          description: The matching banks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BankResDto'
        '401':
          description: Missing or invalid API key (x-api-key header)
      security:
        - x-api-key: []
components:
  schemas:
    BankResDto:
      type: object
      properties:
        id:
          type: string
          description: Bank id
          example: Bank of America
        name:
          type: string
          description: Bank name
          example: Bank of America
        country:
          type: string
          description: Country of the bank
          example: NG
        code:
          type: string
          description: Bank code
          example: '001'
        logo:
          type: string
          description: Bank logo URL
          example: https://example.com/logo.png
          nullable: true
      required:
        - id
        - name
        - country
        - code
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.