Converts an amount from one currency to another using the latest exchange rates. The rates are cached and updated daily from an external API (ExchangeRate-API v6). The system uses USD as the base currency for rate calculations.

Request

• Method: POST
• Path Parameters:
  • baseCurrency (string, required): The source currency code (e.g., "USD", "EUR", "AED"). Will be converted to uppercase automatically.
  • toCurrency (string, required): The target currency code (e.g., "USD", "EUR", "AED"). Will be converted to uppercase automatically.
  • amount (double, required): The amount to convert from baseCurrency to toCurrency
• Headers:
  • Authorization (string, required): Must be "XXXXXX" for authentication. For API key access, please contact info@softasium.com

Response Schema

All responses return HTTP 200 OK with a JSON object containing the following fields:

• message (string): Response message indicating success or error
• status (boolean): true for success, false for error
• result (double): The converted amount on success, 0.0 on error, -1 on authorization failure
• base_currency (string): The source currency code in uppercase
• to_currency (string): The target currency code in uppercase

Success Response (200 OK)

When the conversion is successful:

{
  "message": "Success response!",
  "status": true,
  "result": 367.25,
  "base_currency": "USD",
  "to_currency": "AED"
}

Error Response (200 OK)

When an error occurs during conversion (e.g., invalid currency code):

{
  "message": "Error: Currency code not found",
  "status": false,
  "result": 0.0,
  "base_currency": "USD",
  "to_currency": "INVALID"
}

Authorization Failure Response (200 OK)

When the Authorization header is missing or invalid:

{
  "message": "Invalid Authorization Key!",
  "status": false,
  "result": -1
}

Example Request

Convert 100 USD to AED:

Example Success Response

{
  "message": "Success response!",
  "status": true,
  "result": 367.25,
  "base_currency": "USD",
  "to_currency": "AED"
}

Example Error Response

{
  "message": "Error: Currency code not found",
  "status": false,
  "result": 0.0,
  "base_currency": "USD",
  "to_currency": "INVALID"
}

Example Authorization Failure Response

{
  "message": "Invalid Authorization Key!",
  "status": false,
  "result": -1
}

• Data Source: ExchangeRate-API v6 (https://v6.exchangerate-api.com)
• Caching: Rates are cached in memory and database for optimal performance
• Update Frequency: Rates are updated once per day automatically
• Storage: Currency rates are stored in a Rates object containing all supported currency codes as properties

The API supports all major world currencies including but not limited to:

• Major Currencies: USD (US Dollar), EUR (Euro), GBP (British Pound), JPY (Japanese Yen), CNY (Chinese Yuan)
• Middle East: AED (UAE Dirham), SAR (Saudi Riyal), QAR (Qatari Riyal), KWD (Kuwaiti Dinar), OMR (Omani Rial)
• South Asia: INR (Indian Rupee), PKR (Pakistani Rupee), BDT (Bangladeshi Taka), LKR (Sri Lankan Rupee)
• Other Regions: CAD (Canadian Dollar), AUD (Australian Dollar), CHF (Swiss Franc), NZD (New Zealand Dollar), and many more

All currency codes follow the ISO 4217 standard (3-letter codes). The API supports over 170 world currencies. Currency codes are case-insensitive and will be automatically converted to uppercase.

All requests require authentication via the Authorization header:

• Header Name: Authorization
• Header Value: XXXXXX (For API key access, please contact info@softasium.com)
• Required: Yes

Requests without a valid Authorization header will return an authorization failure response with result: -1.

Common Error Scenarios

• Invalid Currency Code: When baseCurrency or toCurrency is not found in the supported currencies list
• Missing Authorization: When the Authorization header is missing or incorrect
• Invalid Amount: When the amount parameter cannot be parsed as a valid number
• Rate Unavailable: When exchange rates are temporarily unavailable (rare, as rates are cached)

All errors return HTTP 200 OK with status: false and an appropriate error message in the message field.

• All currency codes are automatically converted to uppercase, so "usd", "USD", and "Usd" are treated the same
• The API uses USD as the base currency internally for all rate calculations
• Rates are updated daily from ExchangeRate-API v6 to ensure accuracy
• Cached rates ensure fast response times even during high traffic
• The conversion formula handles cross-currency conversions through USD as an intermediary
• All responses are in JSON format with consistent structure