Get Currency Conversion

GET 
/api/currency/convert

Get a currency conversion estimate based on present conversion rates.

Request

Query Parameters

currency stringrequired

The currency alpha code to convert from

amount stringrequired

The amount of currency to convert to destination currency, an integer in the smallest denomination for the given currency

targetCurrency string

The target currency alpha code for the conversion. Defaults to USD

Responses

200

application/json

Schema

Schema

currency string

The currency to convert from.

convertedCurrency string

The currency converted to.

amount string

The amount of currency to convert to destination currency denominated in the major unit. An integer in the smallest denomination for the given currency.

convertedAmount string

The resulting amount of the conversion from currency into convertedCurrency denominated in the smallest denomination for the given currency.

rate string

The conversion rate applied to arrive at the convertedAmount of the convertedCurrency from the amount of currency.

Example (from schema)

{
  "currency": "string",
  "convertedCurrency": "string",
  "amount": "string",
  "convertedAmount": "string",
  "rate": "string"
}

Example

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

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

Loading...