Currency Exchange Rate Service Provider

Currency Exchange Rate Service Provider for currency conversion in Umbraco Commerce.

Umbraco Commerce can track the current exchange rate of orders compared to the stores . This is necessary to produce reports and analytics in a single currency.

Currency Exchange Rate Services

Umbraco Commerce uses an ICurrencyExchangeRateService to retrieve the most up-to-date rate and track the current exchange rate. This is done for each order.

Out of the box, Umbraco Commerce comes with a number of available services you can choose to use. Some are free services, while others require a paid subscription.

ExchangeRateHostCurrencyExchangeRateService uses the free API.
ExchangeRatesApiCurrencyExchangeRateService uses the free API.
FixerCurrencyExchangeRateService uses the API which is a reliable paid option (with a reasonable free plan).
CurrencyLayerCurrencyExchangeRateService uses the API which is another reliable paid option (with a reasonable free plan).

If you are using multiple currencies in your store then you should sign up for and configure an exchange rate service to ensure accurate reporting. You can do so via the approach. This is used to override the default service configuration. For services that require configuration to be passed in, such as service API keys, you'll need to use the factory-based override as follows:

public static class UmbracoCommerceUmbracoBuilderExtensions
{
    public static IUmbracoCommerceBuilder AddMyServices(IUmbracoCommerceBuilder builder)
    {
        // Register the fixer tax service with your API key
        builder.Services.AddUnique<ICurrencyExchangeRateService>(new FixerCurrencyExchangeRateService("YOUR_FIXER_API_KEY"));
        
        // Return the builder to continue the chain
        return builder;
    }
}

If you have multiple currencies enabled but have not configured an exchange rate service, Umbraco Commerce will display a warning. This alert appears on the store dashboard and analytics section, indicating that the reported data may be inaccurate.

Historic Orders

Umbraco Commerce has a background service that will attempt to ensure that all historic orders without an exchange rate defined get updated. This is done in case the third-party APIs fail and we need a method of cleaning data. It is also done in case the store base currency is ever changed. In this case, we need to re-process all orders again with the newly selected base currency.

The currency exchange rate background task will run once every 24 hours or after 20 seconds after an app pool recycle.

PreviousCalculators NextDependency Injection

Last updated 5 months ago

Was this helpful?

public static class UmbracoCommerceUmbracoBuilderExtensions { public static IUmbracoCommerceBuilder AddMyServices(IUmbracoCommerceBuilder builder) { // Register the fixer tax service with your API key builder.Services.AddUnique<ICurrencyExchangeRateService>(new FixerCurrencyExchangeRateService("YOUR_FIXER_API_KEY")); // Return the builder to continue the chain return builder; } }