Currencies API
Use the Currencies API to retrieve Velosity's currency reference data. Currency records are read-only and identify the country, currency name, ISO-style currency code, and symbol.
All requests require the authentication described in API Authentication.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET |
/v1/setup/currencies |
Returns all currencies, ordered by country. |
GET |
/v1/setup/currencies/{CurrencyID} |
Returns one currency by its Velosity identifier. |
GET |
/v1/setup/currencies/codes/{code} |
Returns one currency by its currency code. |
CurrencyID is the Velosity currency identifier returned by the API. code is a currency code, such as USD.
Currency response
Each endpoint returns a currency object, or an array of currency objects for the list endpoint.
| Field | Description |
|---|---|
currencyID |
Velosity identifier for the currency. Use this value where the API requires a CurrencyID. |
country |
Country associated with the currency. |
currency |
Currency name. |
code |
Currency code. |
symbol |
Currency symbol. |
Examples
GET /v1/setup/currencies HTTP/1.1
Host: api.velosity.one
X-APIKEY: your-api-key
GET /v1/setup/currencies/codes/USD HTTP/1.1
Host: api.velosity.one
X-APIKEY: your-api-key