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

# List Institutions

> Retrieves a list of banks or mobile money providers available for a specific country.

Retrieve a list of banks or mobile money providers available for a specific country and payment channel.


## OpenAPI

````yaml GET /api/v1/payment-method/institution
openapi: 3.1.0
info:
  title: Afriex Business API
  version: 1.0.8
  description: >-
    Welcome to the Afriex Business API. This API allows you to manage customers,
    process payments, handle payouts, and receive real-time notifications via
    webhooks.


    For detailed guidance on authentication, pagination, error handling, and
    webhooks, please refer to the [dedicated guides](https://docs.afriex.com) in
    the top bar. The guide provides a step-by-step instructions to help you
    integrate seamlessly.
  termsOfService: https://www.afriex.com/terms-and-condition
  contact:
    name: Afriex API Support
    email: eng@afriex.co
    url: https://docs.afriex.com
  license:
    name: Proprietary
    url: https://www.afriex.com/terms-and-condition
servers:
  - url: https://sandbox.api.afriex.com
    description: Staging Base URL
  - url: https://api.afriex.com
    description: Production Base URL
security:
  - ApiKey: []
tags:
  - name: Customers
    description: Create and manage your customers.
  - name: Payment Methods
    description: Register and resolve customer payout and collection methods.
  - name: Transactions
    description: Create and track deposits, withdrawals, and swaps.
  - name: Balance
    description: View and top up your business wallet balances.
  - name: Rates
    description: Fetch real-time exchange rates.
  - name: Checkout Sessions
    description: Create hosted checkout sessions.
  - name: Webhooks
    description: Webhook event payloads and sandbox webhook testing.
  - name: Media
    description: Generate presigned URLs for secure file uploads.
paths:
  /api/v1/payment-method/institution:
    parameters:
      - $ref: '#/components/parameters/x-api-signature'
      - $ref: '#/components/parameters/x-api-version'
    get:
      tags:
        - Payment Methods
      summary: Get list of payment method institutions by country
      description: >-
        Retrieves a list of banks or mobile money providers available for a
        specific country.
      operationId: listInstitutions
      parameters:
        - name: channel
          in: query
          description: The payment method channel
          required: true
          schema:
            type: string
            enum:
              - BANK_ACCOUNT
              - SWIFT
              - MOBILE_MONEY
              - UPI
              - INTERAC
              - WE_CHAT
        - name: countryCode
          in: query
          description: The ISO 3166-1 alpha-2 country code
          required: true
          schema:
            type: string
            enum:
              - US
              - NG
              - GB
              - DE
              - FR
              - CA
              - ZA
              - GH
              - KE
              - UG
              - TZ
              - RW
              - CM
              - CG
              - GA
              - CF
              - CI
              - BF
              - ML
              - SN
              - TG
              - BJ
              - NE
              - GN
              - ZM
              - ET
              - MW
              - MZ
              - BW
              - SL
              - LR
              - GM
              - GW
              - CV
              - ST
              - AO
              - KM
              - DJ
              - SO
              - SC
              - MU
              - SZ
              - LS
      responses:
        '200':
          description: List of banks or mobile money providers retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PaymentMethodInstitution'
                  page:
                    type: integer
                    description: Current page number
                  total:
                    type: integer
                    description: Total number of items available
              examples:
                nigeriaBanks:
                  summary: Nigerian bank accounts
                  value:
                    data:
                      - institutionName: Guaranty Trust Bank (GTBank) Plc
                        institutionCode: '000013'
                        institutionBranch: ''
                        institutionAddress: ''
                      - institutionName: Zenith Bank
                        institutionCode: '000015'
                        institutionBranch: ''
                        institutionAddress: ''
                      - institutionName: Wema Bank
                        institutionCode: '000017'
                        institutionBranch: ''
                        institutionAddress: ''
                    total: 38
                    page: 0
                ghanaMobileMoney:
                  summary: Ghana mobile money providers
                  value:
                    data:
                      - institutionName: MTN
                        institutionCode: MTN
                      - institutionName: TIGO
                        institutionCode: TIGO
                      - institutionName: AIRTEL
                        institutionCode: AIRTEL
                    total: 4
                    page: 0
        '400':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingParams:
                  summary: Missing required query parameters
                  value:
                    code: VALIDATION_ERROR
                    error: >-
                      Failed to parse request. Issues: 'countryCode' is
                      required, 'channel' is required
                    details: {}
                invalidChannel:
                  summary: Invalid channel value
                  value:
                    code: VALIDATION_ERROR
                    error: >-
                      Failed to parse request. Issues: 'channel' must be one of
                      [BANK_ACCOUNT, MOBILE_MONEY, SWIFT, ...]
                    details: {}
        '401':
          description: Unauthorized - Invalid business API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingApiKey:
                  summary: Missing API key
                  value:
                    code: AUTHENTICATION_ERROR
                    error: Authorization header is missing
                    details: {}
                invalidApiKey:
                  summary: Invalid API key
                  value:
                    code: AUTHENTICATION_ERROR
                    error: Invalid authorization header
                    details: {}
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                serverError:
                  summary: Unexpected server error
                  value:
                    code: INTERNAL_SERVER_ERROR
                    error: It's not you, it's us, please reach out to support
                    details: {}
      x-codeSamples:
        - lang: TypeScript
          label: Afriex SDK
          source: >
            const institutions = await afriex.paymentMethods.getInstitutions({
              channel: "BANK_ACCOUNT",
              countryCode: "NG",
            });


            // Returns: Institution[], { institutionId, institutionName,
            institutionCode }
components:
  parameters:
    x-api-signature:
      name: x-api-signature
      in: header
      required: false
      description: >-
        Signature of the request payload, used for request authentication where
        payload signing is enabled for your business.
      schema:
        type: string
    x-api-version:
      name: x-api-version
      in: header
      required: false
      description: >-
        API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest
        stable.
      schema:
        type: string
  schemas:
    PaymentMethodInstitution:
      type: object
      properties:
        institutionId:
          type: string
          description: >-
            The unique identifier of the bank or mobile money provider if
            required.
        institutionName:
          type: string
          description: The name of the bank or mobile money provider if required.
        institutionCode:
          type: string
          description: The code of the bank or mobile money provider.
        institutionAddress:
          type: string
          description: The address of the bank or mobile money provider if required.
        correspondentBankName:
          type: string
          description: >-
            The correspondent (intermediary) bank name. Mandatory for USD
            (SWIFT) payout payment methods; required to produce settlement
            advices/invoices.
        correspondentBankAccountNumber:
          type: string
          description: >-
            The correspondent (intermediary) bank account number. Mandatory for
            USD (SWIFT) payout payment methods; required to produce settlement
            advices/invoices.
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code.
        error:
          type: string
          description: Human-readable error message.
        details:
          $ref: '#/components/schemas/ErrorDetails'
    ErrorDetails:
      type: object
      properties:
        errorMessage:
          type: string
          description: Detailed/technical error message.
        friendlyMessage:
          type: string
          description: User-facing error message safe to display.
        data:
          type: object
          description: >-
            Optional caller-safe context for the error. On a customer-create
            uniqueness conflict (EMAIL_ALREADY_EXISTS /
            PHONE_NUMBER_ALREADY_EXISTS) this carries the existing customer's
            id, so you can adopt it without a follow-up lookup.
          properties:
            customerId:
              type: string
              description: Id of the existing customer (on a create conflict).
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Static business API key issued from the dashboard. A business can
        provision **multiple API keys**, each scoped to a configurable set of
        **permissions** (e.g. read transactions, create deposits, etc).
        Permissions are chosen per key at creation time in the dashboard and may
        be revoked by deleting the key. Requests made with a key that does not
        include the permission required by the target endpoint will be rejected
        with a `403 Forbidden` response; an unrecognised, malformed or revoked
        key returns `401 Unauthorized`. Manage your keys and their permissions
        under **Developer → API keys** in the dashboard.

````