Currencies

Get currencies

get

Query parameters

CodestringOptional

The code of the currency.

NamestringOptional

The name of the currency.

NamePluralstringOptional

The plural name of the currency.

SymbolstringOptional

The symbol of the currency.

SymbolNativestringOptional

The native symbol of the currency.

DecimalDigitsinteger · int32Optional

The number of decimal digits for the currency.

Roundingnumber · doubleOptional

The rounding value for the currency.

TagsstringOptional

The tags for the currency.

IsCoinbooleanOptional

Flag to indicate if the currency is a coin.

KeywordsstringOptional

The keywords for the currency.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/currencies

HTTPcURLJavaScriptPython

GET /api/v1/currencies HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": null,
        "code": "USD",
        "name": "US Dollar",
        "namePlural": "US Dollars",
        "symbol": "$",
        "symbolNative": "$",
        "decimalDigits": 2,
        "rounding": 0.01,
        "isCoin": false,
        "isDefault": true
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 20
  },
  "errors": []
}