Skip to content

List All Banks

Retrieve a list of all active banks available in the FLUID Network.

Endpoint

http
GET /api/v1/payment-providers/banks

Authentication

Requires a valid Bearer token in the Authorization header.

http
Authorization: Bearer YOUR_API_TOKEN

Request

No request body or query parameters required.

Example Request

bash
curl --request GET \
  --url https://api.fluid-network.com/api/v1/payment-providers/banks \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json'

Response

Success Response

Status Code: 200 OK

json
{
  "success": true,
  "data": [
    {
      "name": "Example Bank Ghana",
      "identifier": "EXB",
      "country_code": "GH"
    },
    {
      "name": "Demo Bank Ghana",
      "identifier": "DEM",
      "country_code": "GH"
    },
    {
      "name": "Test Bank Ghana",
      "identifier": "TST",
      "country_code": "GH"
    }
  ]
}

Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
dataarrayArray of bank objects
data[].namestringFull name of the bank
data[].identifierstringFLUID Network bank identifier (used in API requests)
data[].country_codestringISO 3166-1 alpha-2 country code

Error Responses

Unauthorized

Status Code: 401 Unauthorized

json
{
  "success": false,
  "error": {
    "code": 1401,
    "message": "Unauthorized",
    "category": "authentication"
  }
}

Rate Limit Exceeded

Status Code: 429 Too Many Requests

json
{
  "success": false,
  "error": {
    "code": 1429,
    "message": "Too many requests",
    "category": "rate_limiting"
  }
}

Usage Notes

  • Banks are returned in alphabetical order by name
  • Only active banks available for transactions are included
  • The identifier field is used when initiating debit requests
  • This endpoint is cached for improved performance
  • Changes to bank availability are rare but can occur

Rate Limits

  • Production: 200 requests per minute
  • Sandbox: 60 requests per minute

Next Steps