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

# List Bank Branches

> Branches of a bank, for countries whose transfers need a branch_code (Ghana and Kenya do; Nigeria does not). The branch code goes into info.branch_code on the send request.

## Overview

Some countries route transfers by branch as well as bank. Ghana and Kenya do; Nigeria does not. For those countries, pick a branch here and send its `branch_code` in `info.branch_code` on [Send payment](/api-reference/payments/send).


## OpenAPI

````yaml GET /v1/banks/{country_code}/{bank_code}
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
  description: >-
    Platnova's Business API allows businesses to issue virtual accounts and
    cards to their employees, vendors, or retail customers. It allows businesses
    to streamline the process of issuing cards, manage spending, and track
    transactions. The API documentation provides information on how to integrate
    our virtual card issuing system into a business's existing systems and
    outlines the features and functionalities of the API, including card and
    account creation, management, and reporting. It also provides technical
    specifications, such as API requests, responses, and authentication
    processes.


    The API documentation is intended for developers and IT teams to use in
    order to effectively implement Platnova solutions into their business
    processes.


    # Authentication/Authorization


    To access any of the resources on the `{BaseUrl}/v1/`, the client has to
    pass pre-defined headers for authentication and authorization.


    The API is secure and only authorized clients can consume the service. There
    are API keys assigned to every business and JWT tokens assigned to every
    account for authentication/authorization.


    ## Bearer Token


    Requests may accept jwt tokens as below.


    ``` json

    Authorization: Bearer <jwt token>

     ```

    ## API Key


    Requests may acccept an api key either in the request headers or as a query
    parameter. Some requests cannot be authorized using an API key.


    ``` json

    X-API-KEY: <api key>

     ```

    OR


    ``` json

    ?api-key=<api key>

     ```

    # Base URL


    [https://sandbox.api.platnova.co](https://sandbox.api.platnova.co)


    # Errors


    Unauthorized API key


    ``` json

    {
        "status": false,
        "data": {},
        "error": [],
        "message": "unauthorized access"
    }

     ```

    Permission Denied


    ``` json

    {
        "status": false,
        "data": {},
        "error": [],
        "message": "unauthorized access: permission denied"
    }

     ```
servers:
  - url: https://api.platnova.com
    description: Production server
  - url: https://sandbox.api.platnova.co
    description: Development server
security:
  - apiKeyAuth: []
tags:
  - name: Customer
    description: Create and manage customers
  - name: Virtual Account
    description: Create and manage virtual accounts
  - name: Card
    description: Create and manage cards
  - name: Wallet
    description: List and manage wallets
  - name: Payment
    description: Send and verify payments
  - name: Transaction
    description: List transactions and generate receipts
  - name: Checkout
    description: Create and retrieve checkout sessions
  - name: Payment Link
    description: Create and manage payment links
  - name: Invoice
    description: Create and manage invoices
  - name: Bank
    description: Bank lists and account verification for bank transfers
paths:
  /v1/banks/{country_code}/{bank_code}:
    get:
      tags:
        - Bank
      summary: List bank branches
      description: >-
        Branches of a bank, for countries whose transfers need a branch_code
        (Ghana and Kenya do; Nigeria does not). The branch code goes into
        info.branch_code on the send request.
      operationId: listBankBranches
      parameters:
        - name: country_code
          in: path
          required: true
          description: ISO 3166-1 alpha-2 country code, e.g. NG, GH, KE
          schema:
            type: string
            example: NG
        - name: bank_code
          in: path
          required: true
          description: A code from the bank list
          schema:
            type: string
            example: GH010100
      responses:
        '200':
          description: Branches retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        branch_code:
                          type: string
                        branch_name:
                          type: string
                        swift_code:
                          type: string
                        bic:
                          type: string
                        bank_id:
                          type: integer
                  error:
                    type: array
                    items: {}
                  message:
                    type: string
                example:
                  status: true
                  data:
                    - id: 1
                      branch_code: GH010101
                      branch_name: Accra Main
                      swift_code: GHIBGHAC
                      bic: GHIB
                      bank_id: 230
                  error: []
                  message: operation was successful
        '400':
          description: >-
            Bad request (e.g. unknown country or bank code, provider
            unavailable)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        status:
          type: boolean
        data:
          type: object
        error:
          type: array
          items: {}
        message:
          type: string
          description: Error message
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key for authentication.

````