Difference between revisions of "Currencies"

From WHMCS Documentation

Line 1: Line 1:
You can configure the currencies you wish to use in your WHMCS installation in '''Setup > Payments > Currencies'''
+
You can configure the currencies you wish to use in your WHMCS installation in '''Setup > Payments > Currencies'''.
  
By default the base currency will be USD. This can be edited and should be changed to your home currency if not USD.  You can then add additional currencies to run alongside that.
+
By default, the base currency is USD. You can edit this, and should change it to your home currency if it's not USD.  You can then add additional currencies.
  
 
'''Currency Setup Guide:'''
 
'''Currency Setup Guide:'''
Line 9: Line 9:
  
 
==Changing the Default Currency==
 
==Changing the Default Currency==
A guide to changing the system default currency [https://help.whmcs.com/m/payments/l/1122770-changing-the-default-currency is published here].
+
You can find a guide to changing the system default currency [https://help.whmcs.com/m/payments/l/1122770-changing-the-default-currency here].
  
 
==Adding/Editing a Currency==
 
==Adding/Editing a Currency==
Line 15: Line 15:
 
The fields for adding or editing a currency are the same.  Below is an explanation of each of these:
 
The fields for adding or editing a currency are the same.  Below is an explanation of each of these:
  
*Currency Code – This should be the standard 3 letter ISO 4217 code used by gateways
+
*Currency Code — The standard three-letter ISO-4217 code that payment gateways use.
*Prefix The text/symbol to display before the amount
+
*Prefix The text or symbol to display before the amount.
*Suffix The text/symbol to display after the amount
+
*Suffix The text or symbol to display after the amount.
*Format – Allows you to choose between the different format styles for currencies
+
*Format — The format style for currencies.
*Base Conv. Rate The rate amounts in this currency should be divided by to get to the base currency, eg. USD to GBP currently 1.5
+
*Base Conv. Rate The rate by which to divide amounts in this currency to get to the base currency. For example, USD to GBP could be 1.5.
  
To find the base conversion rate; visit [http://www.xe.com/ucc/ The Universal Currency Converter], select your default currency in the "From this currency" menu, then select your second currency from the "To this currency" menu and click Go. The base conversion rate will then be displayed as highlighted below:
+
To find the base conversion rate:
 +
#Go to [http://www.xe.com/ucc/ The Universal Currency Converter].
 +
#Select your default currency in the "From this currency" menu.
 +
#Select your second currency from the "To this currency" menu.
 +
#Click Go.  
 +
 
 +
The base conversion rate will appear. For example:
  
 
[[Image:Bcr1.png]]
 
[[Image:Bcr1.png]]
  
The first currency is the default one. If you want to define a default currency you must edit the currency code, and set it to the new default currency.
+
The first currency is the default. If you want to define a default currency, you must edit the currency code and set it to the new default currency.
  
 
==Auto Updating Rates==
 
==Auto Updating Rates==
  
WHMCS has the built in capability to retrieve and update the base conversion rate values daily for the following currencies:
+
WHMCS has the built-in capability to retrieve and update the base conversion rate values daily for the following currencies:
  
USD, EUR, JPY, BGN, CZK, DKK, EEK, GBP, HUF, LTL, LVL, PLN, RON, SEK, CHF, NOK, HRK, RUB, TRY, AUD, BRL, CAD, CNY, HKD, IDR, INR, KRW, MXN, MYR, NZD, PHP, SGD, THB & ZAR
+
USD, EUR, JPY, BGN, CZK, DKK, EEK, GBP, HUF, LTL, LVL, PLN, RON, SEK, CHF, NOK, HRK, RUB, TRY, AUD, BRL, CAD, CNY, HKD, IDR, INR, KRW, MXN, MYR, NZD, PHP, SGD, THB, and ZAR
  
For a full list of international currency codes: [http://en.wikipedia.org/wiki/ISO_4217]
+
For a full list of international currency codes, [http://en.wikipedia.org/wiki/ISO_4217 view ISO-4217].
  
You can manually request the rates to be synced using the Update Exchange Rates button on the currencies page or you can configure it to be automated with the daily cron in '''Setup > Automation Settings'''.
+
You can manually sync the rates using the Update Exchange Rates button on the currencies page. You can configure automation with the daily cron in '''Setup > Automation Settings'''.
  
 
==Auto Updating Prices==
 
==Auto Updating Prices==
  
WHMCS also provides the ability to have the prices in currencies other than the base rate automatically updated based on the rates set. Again you can invoke that manually from the currencies page with the “Update Product Prices” button or you can have it run after the daily rates update in '''Setup > Automation Settings'''.
+
WHMCS also provides the ability to automatically update the prices in currencies other than the base rate based on the rates you set. You can invoke this manually from the currencies page with the “Update Product Prices” button, or have it run after the daily rates update in '''Setup > Automation Settings'''.
  
 
==Specifying Currency in a link==
 
==Specifying Currency in a link==
  
You can link to the order form with a specific currency by simulating what the form shown for currency selection does - eg. cart.php?currency=1 cart.php?currency=2
+
You can link to the order form with a specific currency by simulating the actions for the form. For example, <tt>cart.php?currency=1 cart.php?currency=2</tt>.

Revision as of 18:37, 5 May 2020

You can configure the currencies you wish to use in your WHMCS installation in Setup > Payments > Currencies.

By default, the base currency is USD. You can edit this, and should change it to your home currency if it's not USD. You can then add additional currencies.

Currency Setup Guide:

Watch Video Tutorial

Change Default Currency:

Watch Video Tutorial

Changing the Default Currency

You can find a guide to changing the system default currency here.

Adding/Editing a Currency

The fields for adding or editing a currency are the same. Below is an explanation of each of these:

  • Currency Code — The standard three-letter ISO-4217 code that payment gateways use.
  • Prefix — The text or symbol to display before the amount.
  • Suffix — The text or symbol to display after the amount.
  • Format — The format style for currencies.
  • Base Conv. Rate — The rate by which to divide amounts in this currency to get to the base currency. For example, USD to GBP could be 1.5.

To find the base conversion rate:

  1. Go to The Universal Currency Converter.
  2. Select your default currency in the "From this currency" menu.
  3. Select your second currency from the "To this currency" menu.
  4. Click Go.

The base conversion rate will appear. For example:

Bcr1.png

The first currency is the default. If you want to define a default currency, you must edit the currency code and set it to the new default currency.

Auto Updating Rates

WHMCS has the built-in capability to retrieve and update the base conversion rate values daily for the following currencies:

USD, EUR, JPY, BGN, CZK, DKK, EEK, GBP, HUF, LTL, LVL, PLN, RON, SEK, CHF, NOK, HRK, RUB, TRY, AUD, BRL, CAD, CNY, HKD, IDR, INR, KRW, MXN, MYR, NZD, PHP, SGD, THB, and ZAR

For a full list of international currency codes, view ISO-4217.

You can manually sync the rates using the Update Exchange Rates button on the currencies page. You can configure automation with the daily cron in Setup > Automation Settings.

Auto Updating Prices

WHMCS also provides the ability to automatically update the prices in currencies other than the base rate based on the rates you set. You can invoke this manually from the currencies page with the “Update Product Prices” button, or have it run after the daily rates update in Setup > Automation Settings.

Specifying Currency in a link

You can link to the order form with a specific currency by simulating the actions for the form. For example, cart.php?currency=1 cart.php?currency=2.