Skip to main content

Get Rate of Exchange (ROE)

Returns the set rate of exchange between two requested currencies.

Headers

PropertyValue
Request TypeGET
Content Typeapplication-json
URL{{EnvironmentURL}}/api/services/app/RateOfExchange/GetRateOfExchange?fromCurrencyCode={fromCurrencyCode}&toCurrencyCode={toCurrencyCode}&effectiveDate={effectiveDate}

Please see Environments under Getting Started for test and production environment URLs.

Request Parameters

PropertyTypeDescriptionRequired
fromCurrencyCodestringThe ISO currency code for the currency you want to convert from.
toCurrencyCodestringThe ISO currency code you want to convert to.
effectiveDatedateTimeDate that rate of exchange should be applied between the two currencies.

Sample Request

{
"fromCurrencyCode": "ZAR",
"toCurrencyCode": "USD",
"effectiveDate": 2024-06-07,
}