---
title: "Get list of payment method institutions by country"
method: GET
path: "/api/v1/payment-method/institution"
tags: ["Payment Methods"]
---

# Get list of payment method institutions by country

`GET /api/v1/payment-method/institution`

## Request

- Base URL: `https://sandbox.api.afriex.com`
- URL: `https://sandbox.api.afriex.com/api/v1/payment-method/institution`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/payment-method/institution/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `channel` 'BANK_ACCOUNT' | 'SWIFT' | 'MOBILE_MONEY', required
- `countryCode` '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', required

## Response `200`

List of banks or mobile money providers retrieved successfully.

- object
  - `data` PaymentMethodInstitution[]
    - `institutionId` string: The unique identifier of the bank or mobile money provider if required.
    - `institutionName` string: The name of the bank or mobile money provider if required.
    - `institutionCode` string: The code of the bank or mobile money provider.
    - `institutionAddress` string: The address of the bank or mobile money provider if required.
    - `institutionAddressLine1` string: Optional. First line of `institutionAddress`, for SWIFT payment methods. Used ahead of `recipientAddressLine1`.
    - `institutionAddressCity` string: Optional. City of `institutionAddress`, for SWIFT payment methods.
    - `institutionAddressState` string: Optional. State of `institutionAddress`, for SWIFT payment methods.
    - `institutionAddressZip` string: Optional. Postal or ZIP code of `institutionAddress`, for SWIFT payment methods.
    - `institutionAddressCountry` string: Optional. Country of `institutionAddress`, for SWIFT payment methods.
    - `institutionBranch` string: The branch of the bank. Required when creating a BANK_ACCOUNT payment method in CNY. Bank lists return it too, often as an empty string.
    - `correspondentBankName` string: The correspondent (intermediary) bank name. Mandatory for USD (SWIFT) payout payment methods; required to produce settlement advices/invoices.
    - `correspondentBankAccountNumber` string: The correspondent (intermediary) bank account number. Mandatory for USD (SWIFT) payout payment methods; required to produce settlement advices/invoices.
  - `page` integer: Current page number
  - `total` integer: Total number of items available

## Other responses

- `400`: Invalid request parameters.
- `401`: Unauthorized - Invalid business API key.
- `500`: Server error.
- `503`: Temporarily unavailable: an upstream service failed or timed out, or the API is momentarily offline. Retry with backoff and honour the Retry-After header when present.

---

[API](https://skmtc.dev/afriex/apis/afriex-business-api.md) - [All operations](https://skmtc.dev/afriex/apis/afriex-business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/afriex/apis/afriex-business-api/revisions/d94198b6c256?raw)