Go Headless

Build Apps

Client

API Preview

test

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

Identifying details needed to determine which currency rate to convert. The combination of the `from` and `to` properties together comprise the unique ID.

identifiers

ConvertCurrencyIdentifiers

amounts

Returns an array of amounts converted from the original (`from`) currency to the target (`to`) currency and the timestamp for the conversion rate used.


Use the `convertCurrency()` function to convert an array of one or more amounts between two currencies. The `convertCurrency()` function returns an array of converted amounts and the timestamp for the conversion rate used.

> **Note**:  The currency codes used must exist in the array of supported currencies returned by the [`listCurrencies()`](#listcurrencies) function.

import { currencies } from '@wix/ecom';

async function convertCurrency(identifiers, amounts) {
  const response = await currencies.convertCurrency(identifiers, amounts);
};

convertCurrency: Wix-hosted

import { createClient } from '@wix/sdk';
import { currencies } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { currencies },
  // Include the auth strategy and host as relevant
});


async function convertCurrency(identifiers, amounts) {
  const response = await myWixClient.currencies.convertCurrency(identifiers, amounts);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

convertCurrency: Self-hosted

convertCurrency

Manage Currencies

Manage Stores - all permissions

ConvertCurrencyResponse

Identifying details needed to get the conversion rate. The combination of the `from` and `to` properties together comprise the unique ID.

GetConversionRateIdentifiers

Returns the conversion rate between 2 currencies.

import { currencies } from '@wix/ecom';

async function getConversionRate(identifiers) {
  const response = await currencies.getConversionRate(identifiers);
};

getConversionRate: Wix-hosted

import { createClient } from '@wix/sdk';
import { currencies } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { currencies },
  // Include the auth strategy and host as relevant
});


async function getConversionRate(identifiers) {
  const response = await myWixClient.currencies.getConversionRate(identifiers);
};

getConversionRate: Self-hosted

getConversionRate

ConversionRateResponse

Returns an array of currencies. The array lists all currencies for which Wix supports conversion and their symbols.

import { currencies } from '@wix/ecom';

async function listCurrencies() {
  const response = await currencies.listCurrencies();
};

listCurrencies: Wix-hosted

import { createClient } from '@wix/sdk';
import { currencies } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { currencies },
  // Include the auth strategy and host as relevant
});


async function listCurrencies() {
  const response = await myWixClient.currencies.listCurrencies();
};

listCurrencies: Self-hosted

listCurrencies

ListCurrenciesResponse

---
title: Introduction
---
# Introduction

&nbsp;



The Currencies API is used to convert from one currency to another and get exchange rates.


 Currency rates are provided by [XE](https://www.xe.com/company/) and are updated on a daily basis. Rates are provided together with the timestamp when they were set. By using the Currencies API you agree to XE's [Terms of Use](https://www.xe.com/en/legal/dfs.php).

 The Currencies API provides these functions: 

- Use [`listCurrencies()`](ecom/currencies/list-currencies) to get a list of all the convertible currencies.
- Use [`convertCurrency()`](ecom/currencies/convert-currency) to convert amounts between two currencies.
- Use [`getConversionRate()`](ecom/currencies/get-conversion-rate) to get today’s conversion rate for a pair of currencies.  


## Before you begin

+ To use the Currencies API you must upgrade your site to a [Premium Plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683). 

+ The currency converter changes the displayed prices on your site for different currencies but does not change the payment currency. The payment is always made in the [currency set in your site's Dashboard](https://support.wix.com/en/article/setting-your-currency-for-accepting-payments).

+ The currency codes used must exist in the array of supported currencies returned by the [`listCurrencies()`](ecom/currencies/list-currencies) function.

## Terminology

+ **XE**. A [currency converter provider](https://www.xe.com/company/) that the Currencies API uses. 
+ **Currency code**: A 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code representing each currency.

To use the Currencies API, install the `@wix/ecom` package using npm or Yarn:
  ```console
npm install @wix/ecom
```

or

```console
yarn add @wix/ecom
```

Then import `{ currencies }` from `@wix/ecom`:

```js
import { currencies } from '@wix/ecom'
```
  

ecom_currencies

rate

DecimalValue

Date and time the conversion rate was last updated.

rateTimestamp

Original currency to convert from as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `from` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function.

from

string

Target currency to convert to as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code.  The `to` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function.

Currency

A 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.

code

symbol

Decimal places to apply. For example, the number of decimal places for `10.95`  is `2`.

decimalPlaces

number

The value without decimal points. For example, the number `10.95` becomes `1095`.

value

Original currency to get the rate for as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `from` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function.

Target currency to get the rate for as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `to` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function.

getConversionRate( )