Currency

Owned by Joel Morgan Kearney (Unlicensed)
Last updated: Mar 01, 2019 by Joel Kearney
1 min read

The Currency API is used to access the different currency objects on your business' account.

On this page



Currency API Endpoints

Return to Top

These are the endpoints that are available under the /currency path, which lists all the different currencies that are available on your business account.

Endpoint

Description

GET /currency

Returns all currency objects available on your business' account in array format. You can set the business object's currency property to one of the objects returned in this array.



Currency API Parameters

Return to top

There are no parameters included with currency calls.



Currency API Responses

Return to Top

GET /currency 
[{
    "currencyCode": "USD",
    "currencyId": 1,
    "currencyName": "US Dollars",
    "prefix": "$"
}]



Currency Object Values

Return to Top

Property name

Type

Description

currencyCode

string

Displays as the code used to signify the specified currency.

currencyId

integer

Provides unique numeric ID for the specified currency.

currencyName

string

Displays as the name of the specified currency.

prefix

string

Displays as the symbol used to prefix the monetary amount of the specified currency. Example: "$".