GET api/currencies

Returns a collection of the active currencies on WePlann.

Note that the exchange rate returned does not follow the international exchange rate. The exchange rate is the rate that WePlann exchanges from dollars to the currency and may include additional markup.

Resource URLs

Tests: https://sandbox.weplann.com/api/currencies
Production: https://developer.weplann.com/api/currencies

Response Information

Name Description Type Additional Information
TotalCount The total number of active currencies integer
Values collection of currency
 + Code ISO 4217 Currency Code string
 + Name Name of the currency string
 + Rate Current WePlann exchange Rate from US Dollars decimal
 + DisplaySymbol The symbol used to display ($) string

Example Request

GET https://developer.weplann.com/api/currencies 

Example Result (XML)

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.weplann.com">
	<TotalCount>9</TotalCount>
	<Values>
		<Currency Code="ARS">
			<Name>Argentine Peso</Name>
			<Rate>15.3224</Rate>
			<DisplaySymbol>$</DisplaySymbol>
		</Currency>
		<Currency Code="BRL">
			<Name>Brazil Reais</Name>
			<Rate>4.1653</Rate>
			<DisplaySymbol>R$</DisplaySymbol>
		</Currency>
		<Currency Code="CLP">
			<Name>Chile Pesos</Name>
			<Rate>726.5715</Rate>
			<DisplaySymbol>$</DisplaySymbol>
		</Currency>
		<Currency Code="COP">
			<Name>Colombia Pesos</Name>
			<Rate>3433.2372</Rate>
			<DisplaySymbol>$</DisplaySymbol>
		</Currency>
		<Currency Code="EUR">
			<Name>Euro</Name>
			<Rate>0.9082</Rate>
			<DisplaySymbol>€</DisplaySymbol>
		</Currency>
		<Currency Code="GBP">
			<Name>British Pound Sterling</Name>
			<Rate>0.6884</Rate>
			<DisplaySymbol>£</DisplaySymbol>
		</Currency>
		<Currency Code="MXN">
			<Name>Mexico Pesos</Name>
			<Rate>18.6639</Rate>
			<DisplaySymbol>$</DisplaySymbol>
		</Currency>
		<Currency Code="PEN">
			<Name>Peru Nuevos Soles</Name>
			<Rate>3.4819</Rate>
			<DisplaySymbol>S/.</DisplaySymbol>
		</Currency>
		<Currency Code="USD">
			<Name>United States Dollar</Name>
			<Rate>1.0000</Rate>
			<DisplaySymbol>$</DisplaySymbol>
		</Currency>
	</Values>
</Response>

Example Result (JSON)

{
	"totalCount" : 9,
	"values" : [
		{
			"code" : "ARS",
			"name" : "Argentine Peso",
			"rate" : 15.3224,
			"displaySymbol" : "$"
		},
		{
			"code" : "BRL",
			"name" : "Brazil Reais",
			"rate" : 4.1653,
			"displaySymbol" : "R$"
		},
		{
			"code" : "CLP",
			"name" : "Chile Pesos",
			"rate" : 726.5715,
			"displaySymbol" : "$"
		},
		{
			"code" : "COP",
			"name" : "Colombia Pesos",
			"rate" : 3433.2372,
			"displaySymbol" : "$"
		},
		{
			"code" : "EUR",
			"name" : "Euro",
			"rate" : 0.9082,
			"displaySymbol" : "€"
		},
		{
			"code" : "GBP",
			"name" : "British Pound Sterling",
			"rate" : 0.6884,
			"displaySymbol" : "£"
		},
		{
			"code" : "MXN",
			"name" : "Mexico Pesos",
			"rate" : 18.6639,
			"displaySymbol" : "$"
		},
		{
			"code" : "PEN",
			"name" : "Peru Nuevos Soles",
			"rate" : 3.4819,
			"displaySymbol" : "S/."
		},
		{
			"code" : "USD",
			"name" : "United States Dollar",
			"rate" : 1.0000,
			"displaySymbol" : "$"
		}
	]
}