---
title: "GET /v3/payout/bank"
method: GET
path: "/v3/payout/bank"
---

# GET /v3/payout/bank

`GET /v3/payout/bank`

search and retrieve bank entities from global bank directory [GET]

## Query parameters

- `country` string, required
- `search_text` string, required
- `code_type` 'swift_code' | 'sort_code' | 'aba_code' | 'bsb_code' | 'ifsc_code' | 'iban' | 'bank_name', required
- `limit` integer
- `offset` integer

## Response `200`

Successful response

- ListBanksResponse — List banks response wrapper.
  - `status` string
  - `message` string
  - `data` ListBanksResponseData
    - `has_more` boolean
    - `object` string — Always "list".
    - `results` GlobalBankDirectoryBank[]
      - `id` string — Unique ID of the bank entity.
      - `object` string — Always "bank".
      - `bank_name` string — Bank name.
      - `country_code` string — Two-letter country code (ISO 3166-1 alpha-2).
      - `address` Address — Address details
        - `line1` string — Address Line 1
        - `line2` string — Address Line 2
        - `city` string — Address city
        - `state` string — Address state
        - `country` string — Address country (ISO 3166-1 alpha-2 country code)
        - `postal_code` string — Postal Code
      - `bank_codes` BankCodes — Bank specific identification codes
        - `swift_code` string — SWIFT Code
        - `bic_code` string — Bank Identifier Code (BIC)
        - `ifsc_code` string — IFS Code
        - `aba_code` string — ABA / Routing Number
        - `sort_code` string — SORT Code
        - `branch_code` string — Branch Code
        - `bsb_code` string — BSB Code
        - `bank_code` string — Bank Code
        - `cnaps` string — CNAPS
      - `matched_on` object — Fields that matched the search criteria.

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.net/tazapay/apis/sandbox.md) · [All operations](https://skmtc.net/tazapay/apis/sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tazapay/sandbox/revisions/bf5f4b8f6f5d/schema)