Connectors Reference
The currency APIs help you retrieve exchange rates and convert prices between currencies easily.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Get a list of available currencies and corresponding countries |
|
|
CurrencyExchange_ConvertCurrency (string source, string destination, number sourcePrice) |
Converts a price from the source currency into the destination currency |
|
CurrencyExchange_GetExchangeRate (string source, string destination) |
Gets the exchange rate from the source currency into the destination currency |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
Summary: Get a list of available currencies and corresponding countries
Description: Enumerates available currencies and the countries that correspond to these currencies.
Syntax:
CloudmersiveCurrency.CurrencyExchange_GetAvailableCurrencies ()
Returns:
Type:AvailableCurrencyResponse
Description: Result of performing an enumerate currencies operation
Summary: Converts a price from the source currency into the destination currency
Description: Automatically converts the price in the source currency into the destination currency using the latest available currency exchange rate data.
Syntax:
CloudmersiveCurrency.CurrencyExchange_ConvertCurrency (string source, string destination, number sourcePrice)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
source |
string (Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc.) |
Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc. |
True |
|
|
destination |
string (Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc.) |
Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc. |
True |
|
|
sourcePrice |
number(double)
|
|
True |
Returns:
Description: Result of performing a Convert Currency operation
Summary: Gets the exchange rate from the source currency into the destination currency
Description: Automatically gets the exchange rate from the source currency into the destination currency using the latest available currency exchange rate data.
Syntax:
CloudmersiveCurrency.CurrencyExchange_GetExchangeRate (string source, string destination)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
source |
string (Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc.) |
Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc. |
True |
|
|
destination |
string (Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc.) |
Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc. |
True |
Returns:
Type:ExchangeRateResult
Description: Result of performing a get exchange rate operation
Summary:
Description: Details of a specific currency
Properties:
|
Name |
Type |
Summary |
|
ISOCurrencyCode |
string
|
ISO 4217 currency three-letter code associated with the country |
|
CurrencySymbol |
string
|
Symbol associated with the currency |
|
CurrencyEnglishName |
string
|
Full name of the currency |
|
CountryName |
string
|
Name of the country |
|
CountryThreeLetterCode |
string
|
Three-letter ISO 3166-1 country code |
|
CountryISOTwoLetterCode |
string
|
Two-letter ISO 3166-1 country code |
|
IsEuropeanUnionMember |
boolean
|
True if this country is currently a member of the European Union (EU), false otherwise |
Summary:
Description: Result of performing an enumerate currencies operation
Properties:
|
Name |
Type |
Summary |
|
Currencies |
array of (AvailableCurrency)
|
List of available currencies from the API |
Summary:
Description: Result of performing a Convert Currency operation
Properties:
|
Name |
Type |
Summary |
|
ConvertedPrice |
number(double)
|
The converted price in the destination currency |
|
ISOCurrencyCode |
string
|
ISO 4217 currency three-letter code of destination price |
|
CurrencySymbol |
string
|
Destination currency symbol |
|
FormattedPriceAsString |
string
|
Formatted price in the destination currency as a string |
Summary:
Description: Result of performing a get exchange rate operation
Properties:
|
Name |
Type |
Summary |
|
ExchangeRate |
number(double)
|
The exchange rate from the source to the destination currency |