List Banks

Get a list of banks supported on Terraswitch.

GET {{ BASE_URL }}/v1/banks/list

Note: Your "PUBLIC API KEY" is required to get list of banks supported. You can obtain your Public API Key here

Optional Query Parameters

Property	Data Type	Description	Example
limit	string	Number of records per page	50
page	string	Page number to view	1
order	string	Arrangement of records in descending or ascending order	"asc" or "desc"

Node.js

import Axios from 'axios';

// set the api url
const API_URL = `${BASE_URL}/v1/banks/list`;

// make request using axios
Axios({
    method: "GET",
    url: `${API_URL}`,
    headers: {
        lg: 'en',
        ch: 'web'
        Authorization: `Bearer ${API_KEY}`,
        'Content-Type': 'application/json',
    }
}).then((resp) => {
    console.log(resp)
}).catch((err) => {
    console.log(err)
})

Response

{
    "error": false,
    "errors": [],
    "count": 4,
    "total": 533,
    "pagination": {
        "next": {
            "page": 2,
            "limit": 4
        }
    },
    "data": [
        {
            "name": "INFINITY MICROFINANCE BANK",
            "code": "090157",
            "country": "nigeria",
            "currency": "NGN",
            "isEnabled": true,
            "type": "nuban",
            "createdAt": "2024-01-20T09:21:39.280Z",
            "updatedAt": "2024-01-20T09:21:39.280Z"
        },
        {
            "name": "Imo State MFB",
            "code": "090258",
            "country": "nigeria",
            "currency": "NGN",
            "isEnabled": true,
            "type": "nuban",
            "createdAt": "2024-01-20T09:21:39.280Z",
            "updatedAt": "2024-01-20T09:21:39.280Z"
        },
        {
            "name": "Imowo Microfinance Bank",
            "code": "090417",
            "country": "nigeria",
            "currency": "NGN",
            "isEnabled": true,
            "type": "nuban",
            "createdAt": "2024-01-20T09:21:39.280Z",
            "updatedAt": "2024-01-20T09:21:39.280Z"
        },
        {
            "name": "Ilora Microfinance Bank",
            "code": "090430",
            "country": "nigeria",
            "currency": "NGN",
            "isEnabled": true,
            "type": "nuban",
            "createdAt": "2024-01-20T09:21:39.280Z",
            "updatedAt": "2024-01-20T09:21:39.280Z"
        }
    ],
    "message": "successful",
    "status": 200
}