Get Currency Conversion

get/api/currency/convert

Get a currency conversion estimate based on present conversion rates.

Request

Query Parameters

currencystringrequired
The currency alpha code to convert from
amountstringrequired
The amount of currency to convert to destination currency, an integer in the smallest denomination for the given currency
targetCurrencystring
The target currency alpha code for the conversion. Defaults to USD

Response

Successful operation.

Body application/json

currencystring
The currency to convert from.
convertedCurrencystring
The currency converted to.
amountstring
The amount of currency to convert to destination currency denominated in the major unit. An integer in the smallest denomination for the given currency.
convertedAmountstring
The resulting amount of the conversion from currency into convertedCurrency denominated in the smallest denomination for the given currency.
ratestring
The conversion rate applied to arrive at the convertedAmount of the convertedCurrency from the amount of currency.

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/currency/convert?currency=string&amount=string' \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/currency/convert?currency=string&amount=string' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

curl 'https://test.immersve.com/api/currency/convert?currency=string&amount=string' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

Example Response

{
  "currency": "NZD",
  "convertedCurrency": "USD",
  "amount": 1000,
  "convertedAmount": 696.2285,
  "rate": 0.6962285
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}