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

# Fetch All Branches

> This fetches all branches that have been created by a Payaza account.



## OpenAPI

````yaml /openapi.json get /branches/api/v1/merchant-branches
openapi: 3.0.1
info:
  title: Payaza Documentation
  version: 2.0.0
  description: >-
    API reference for processing payments using Card, Bank Transfer, USSD, and
    QR Code methods.
servers:
  - url: https://api.payaza.africa/live
security:
  - ApiKeyAuth: []
  - TenantID: []
  - ProductID: []
tags:
  - name: Transfers
    description: >-
      Transfers are transactions made from your Payaza account to beneficiaries.
      Merchants can instantly transfer funds from their available balance. For
      every transfer, you need to specify the amount and the beneficiary’s
      details. You become eligible to make transfers after you have been
      verified. (you sign up, finish account activation and KYC verification).
  - name: Payaza Account
    description: >-
      This is our internal account that can be used to make payouts to other
      bank accounts, in single or in bulk. The Payaza account can also be used
      to receive settlements. It can also be used to track the transfer status
      of your transactions and check your balance instantly
  - name: Sub Accounts
    description: >-
      This enables you to establish Sub Payaza accounts for your customers. Each
      sub-account comes with an assigned static virtual account, facilitating
      direct funding for individual accounts. Furthermore, the Main Payaza
      account can directly initiate funding for each sub-account. These
      sub-accounts serve the purpose of managing unique account positions or
      balances and facilitating disbursements from these positions to specified
      beneficiaries.
  - name: EUR Accounts
    description: >-
      This endpoints enable you to create EUR subaccounts which can be used to
      make transfers as required .
  - name: Apple Pay and Google Pay
    description: >-
      Apple Pay and Google Pay give your customers a fast, familiar, and secure
      way to complete payments. Our APIs provide a gateway to provide these
      services to your users for a smooth payment experience.
  - name: Virtual Accounts
    description: >-
      Virtual Accounts are bank accounts that are created for a specific purpose
      and last for specified durations. Virtual accounts are issued by Payaza’s
      partner banks. Our virtual account APIs can be used to create virtual
      accounts and perform other tasks relevant to virtual accounts. Virtual
      accounts are created to foster easy payment collections for your business
      and platform. 

      Static/Reserved Account: This virtual account is created by the merchant
      and remains valid indefinitely. It can be used multiple times and does not
      expire. 

      Dynamic Account: This virtual account is generated for a specific
      transaction or purpose. Please note that dynamic virtual account remains
      valid for a temporary period of time or until a payment of the specified
      amount is received. Upon expiry, a merchant can generate another one for a
      different purpose.
  - name: Card Collection
    description: >-
      The Card Collection APIs can be used to make card transactions, refund
      transactions that have been performed, check the status of a transaction
      and so much more.
  - name: Card Tokenisation
    description: >-
      The Card Tokenisation APIs are used to create card tokens, charge cards
      using tokens, retrieve all tokens created by a merchant account and
      deleting any card token as desired.
  - name: Refunds And Chargebacks
    description: >-
      The Refunds and Chargeback APIs are used to initiate refunds, view your
      refund and chargeback history and so much more.
  - name: Branches
    description: >-
      The Refunds and Chargeback APIs are used to initiate refunds, view your
      refund and chargeback history and so much more.
  - name: Auth-Capture-Void
    description: >-
      The Auth-Capture-Void APIs provide a two-phase payment process where
      transactions are first authorized, then captured or voided. This allows
      merchants to hold funds and complete the transaction in the future.
  - name: Momo and ZAR Collections
    description: APIs for MoMo, ZAR and XOF collections.
  - name: Check Transaction Status(Merchant Reference)
    description: >-
      This endpoint is used to check the transaction status of a transaction
      using the Merchant Reference..
paths:
  /branches/api/v1/merchant-branches:
    get:
      tags:
        - Branches
      summary: Fetch All Branches
      description: This fetches all branches that have been created by a Payaza account.
      responses:
        '200':
          description: Fetch All Branches Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fetchAllBranchesResponse'
              examples:
                Fetch All Branches:
                  summary: Fetch All Branches
                  value:
                    message: Merchant branches fetched successfully
                    success: true
                    status: 200
                    data:
                      - name: Mr. Aaron & Sons Co
                        status: Active
                        branch_id: 8589
                        account_name: Mr. Aaron & Sons Co
                        created_at: '2025-10-24T11:23:18.144631'
                      - name: A new center
                        status: Active
                        branch_id: 5553
                        account_name: Dev Guide 1
                        created_at: '2025-02-17T12:41:58.381125'
                      - name: Rest Branch 400
                        status: Active
                        branch_id: 3738
                        account_name: Rest Branch 10
                        created_at: '2024-07-10T14:31:23.817782'
                    meta:
                      page: 1
                      limit: 100
                      total: 3
                    resp_code: BRN_S200
        '400':
          description: Payment failed
      security:
        - ApiKeyAuth:
            - Payaza {{Public API Key In Base64}}
components:
  schemas:
    fetchAllBranchesResponse:
      title: Fetch All Branches Response
      type: object
      properties:
        message:
          type: string
          description: Status message.
          example: Merchant branches fetched successfully
        success:
          type: boolean
          description: Indicates if the request was successful.
          example: true
        status:
          type: integer
          description: HTTP status code.
          example: 200
        data:
          type: array
          description: List of merchant branches.
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the branch.
                example: Mr. Aaron & Sons Co
              status:
                type: string
                description: Current status of the branch (e.g., Active).
                example: Active
              branch_id:
                type: integer
                description: Unique identifier for the branch.
                example: 8589
              account_name:
                type: string
                description: Account name associated with the branch.
                example: Mr. Aaron & Sons Co
              created_at:
                type: string
                format: date-time
                description: Timestamp when the branch was created.
                example: '2025-10-24T11:23:18.144631'
        meta:
          type: object
          description: Pagination metadata.
          properties:
            page:
              type: integer
              description: Current page number.
              example: 1
            limit:
              type: integer
              description: Number of items per page.
              example: 100
            total:
              type: integer
              description: Total number of branches found.
              example: 3
        resp_code:
          type: string
          description: Internal response code.
          example: ''
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Payaza {{Public API Key in Base 64}}
    TenantID:
      type: apiKey
      in: header
      name: X-TenantID
      description: live or test
    ProductID:
      type: apiKey
      in: header
      name: X-ProductID
      description: 'default value is ‟app” '

````