Currency Conversion API

The Currency Conversion API allows developers to convert a given amount from one currency to another using real-time exchange rates. This API is designed for applications requiring accurate and up-to-date currency conversion.

Supported Currencies

The API supports the following currencies:

USD, ARS, BBD, BSD, PYG, PAB, BRL, BMD, BOB, BZD, XCD, DOP, COP,
CRC, CUP, HTG, ANG, HNL, CAD, KYD, PEN, MXN, NIO, TTD, GTQ, VES,
UYU, JMD, CLP, AUD, MOP, PKR, PHP, FJD, HKD, KRW, KHR, LAK, MYR,
BDT, MMK, NPR, CNY, JPY, SCR, LKR, XPF, THB, BND, SGD, TWD, NZD,
INR, IDR, VND, ALL, BYN, BGN, ISK, PLN, DKK, RUB, CZK, HRK, RON,
MKD, MDL, NOK, EUR, SEK, CHF, RSD, UAH, HUF, GBP, AED, OMR, AZN,
BHD, GEL, KZT, KGS, QAR, KWD, LBP, SAR, TRY, TMT, UZS, AMD, YER,
IQD, IRR, ILS, JOD, DZD, EGP, ETB, AOA, BWP, BIF, XOF, CVE, GMD,
DJF, GNF, GHS, KES, LSL, LYD, RWF, MWK, MUR, MAD, NAD, ZAR, NGN,
SZL, SDG, SOS, TZS, TND, UGX, ZMW, XAF, BAM, SYP

The Currency Conversion Model

The API returns exchange rate details and the converted amount.

Properties

Name
status
Type
string
Description
The status of the API request, typically "success" when the request is processed successfully.
Name
payload
Type
object
Description
The main response object containing conversion details.
Name
from_currency
Type
string
Description
The currency code of the source currency.
Name
to_currency
Type
string
Description
The currency code of the target currency.
Name
rate
Type
number
Description
The exchange rate used for the conversion.
Name
value
Type
number
Description
The converted amount in the target currency.
Name
request_id
Type
string
Description
A unique identifier for tracking the request.
Name
request_time
Type
timestamp
Description
The timestamp when the request was made.

POST/v1/utilities/currency/convert

Convert Currency

This endpoint allows you to convert a specified amount from one currency to another using live exchange rates.

Required Attributes

Name
from
Type
string
Description
The three-letter currency code for the source currency.
Name
to
Type
string
Description
The three-letter currency code for the target currency.
Name
amount
Type
number
Description
The amount to convert (must be a positive integer).

Request

POST

/v1/utilities/currency/convert

curl --location 'https://api.stack-ft.com/v1/utilities/currency/convert' \
--header 'Authorization: {api_key}' \
--header 'Content-Type: application/json' \
--data '{
  "from": "USD",
  "to": "KES",
  "amount": 100
}'

Response

{
  "status": "success",
  "payload": {
    "from_currency": "USD",
    "to_currency": "KES",
    "rate": 129.5,
    "value": 12950
  },
  "request_id": "981d73d9-2ee7-4184-9cab-cc4fd2ff6579",
  "request_time": "2025-02-25T01:35:54.346Z"
}

Error Handling & Troubleshooting

Common Errors

Name
missing_parameters
Type
400 Bad Request
Description
Returned if the request is missing required parameters (e.g., from, to, or amount).
Name
invalid_currency
Type
400 Bad Request
Description
Returned if either from or to currency is not supported.
Name
invalid_amount
Type
400 Bad Request
Description
Returned if the amount is not a positive integer.
Name
identical_currency
Type
400 Bad Request
Description
Returned if the from and to currencies are the same.
Name
server_error
Type
500 Internal Server Error
Description
Returned if the server encounters an unexpected issue.

Example Error Response

{
  "status": "error",
  "message": "Invalid currency code provided.",
  "request_id": "c1a7f3e2-1a94-4b82-b9b2-445a1b6242cd",
  "request_time": "2025-02-25T01:40:21.564Z"
}

For additional support, ensure that all parameters are correctly formatted before contacting customer service.