TechVibs Bank List API Documentation

This API provides a list of all banks and their associated codes, which can be used to populate selection menus within client applications. It is a read-only endpoint that supports filtering and pagination.

🔍 Live Bank Search

Get your fintech token from your account dashboard

Base URL

https://techvibs.com/bank/api_general/bankList_general_local_db_api.php

Authentication

All requests must include a valid fintech token for authentication. This token must be included in the Authorization header as a Bearer token or as a parameter in the request body/query string.

Obtaining the Fintech Token

Clients can obtain their unique fintech token by logging into their account at the following URL: https://techvibs.com/bank/login_backend.php

Endpoints

Retrieve Bank List

GET or POST /bankList_general_local_db_api.php

Retrieves a paginated list of banks. The list can be filtered using a search query.

Request Parameters

The following parameters can be sent in the request query string (for GET) or JSON body (for POST):

Parameter	Type	Required	Description	Validation
query	string	No	A search term to filter banks by name or code.	Searches `bankName`, `bankCode`, or `nibssBankCode`.
limit	integer	No	The maximum number of results to return per page.	Defaults to `100`. Max `500`.
offset	integer	No	The number of records to skip for pagination.	Defaults to `0`.
token	string	Yes	The authentication token. Recommended to use the `Authorization` header instead.	-

Notes on Authentication

For GET requests, the token can be in the Authorization: Bearer header or a token query parameter.
For POST requests, the token can be in the Authorization: Bearer header or a token field in the JSON body.

Example GET Request (with Authorization Header)

Fetch the first 5 banks with "access" in their name or code.

curl "https://techvibs.com/bank/api_general/bankList_general_local_db_api.php?query=access&limit=5" \\n  -H "Authorization: Bearer YOUR_FINTECH_TOKEN_HERE"

Example POST Request (with JSON Body)

Fetch a list of banks using a POST request with the token and parameters in the body.

curl -X POST "https://techvibs.com/bank/api_general/bankList_general_local_db_api.php" \\n  -H "Content-Type: application/json" \\n  -d '{\n    "query": "bank",\n    "limit": 10,\n    "offset": 0,\n    "token": "YOUR_FINTECH_TOKEN_HERE"\n}'

Responses

The API will respond with a JSON object. The success field indicates the result of the request.

Success Response (HTTP Status: 200 OK)

A successful request returns a list of banks along with pagination information.

{
    "success": true,
    "data": {
        "total": 150,
        "count": 10,
        "banks": [
            {
                "id": "1",
                "bankName": "Access Bank",
                "bankCode": "044",
                "nibssBankCode": "000001",
                "last_updated": "2023-10-27 10:30:00"
            },
            {
                "id": "2",
                "bankName": "First Bank of Nigeria",
                "bankCode": "011",
                "nibssBankCode": "000010",
                "last_updated": "2023-10-27 10:31:00"
            }
        ],
        "token_info": {
            "fintech_name": "Client Fintech Name",
            "token_type": "live"
        }
    }
}

Error Responses (Various HTTP Statuses)

Errors are returned with a success: false field and an informative message.

Authentication Token Required (401 Unauthorized)

{
    "success": false,
    "error": "Authentication token required. Use Authorization: Bearer <token> header or token parameter"
}

Invalid Token (401 Unauthorized)

{
    "success": false,
    "error": "Invalid token"
}

Token Service Unavailable (401 Unauthorized)

{
    "success": false,
    "error": "Token service unavailable"
}

Internal Server Error (500 Internal Server Error)

{
    "success": false,
    "error": "A general server error occurred."
}