Fetch Supported Currencies
This endpoint returns the complete list of currencies supported by the platform, each with its ISO 4217 currency code, display name, and ISO 4217 numeric code. The currency code is used when creating institutions or filtering institution records by currency.
GET {{host}}/api/v1/institutions/currencies
Response Message Field Description
| # | Field Name | Description |
|---|---|---|
| 1 | success | Indicates whether the request was successful (true for success) |
| 2 | responseCode | HTTP-like response code (e.g. 200 for success) |
| 3 | responseMessage | Human-readable result message (e.g. Success) |
| 4 | data | Array of currency objects |
| 4.1 | data[].code | ISO 4217 alphabetic currency code (e.g. NGN) |
| 4.2 | data[].name | Full display name of the currency (e.g. Nigerian Naira) |
| 4.3 | data[].isoCode | ISO 4217 numeric code for the currency (e.g. 566) |
Sample Response (Success)
{
"success": true,
"responseCode": "200",
"responseMessage": "Success",
"data": [
{
"code": "NGN",
"name": "Nigerian Naira",
"isoCode": "566"
},
{
"code": "USD",
"name": "US Dollar",
"isoCode": "840"
},
{
"code": "GHS",
"name": "Ghana Cedi",
"isoCode": "936"
}
]
}Sample Response (Failure)
{
"success": false,
"responseCode": "500",
"responseMessage": "An unexpected error occurred"
}Updated about 11 hours ago
Did this page help you?
