User Tools

Site Tools


developers:api:currency

This is an old revision of the document!


Currencies

/v1/currency/code/get

Get the specified currency details.

Parameter listing

Name Availability Description
code get The unique ISO 4217 code three letter code for the currency, which is always specified in upper case.
format get A printf style format string for rendering amounts in this currencies standard format.
enabled get Boolean value indicating whether the currency is enabled on the current account or not.

/v1/currency/list

List currencies on the system.

If you don't specify a 'state' argument, then only currencies which are enabled will be shown.

Results can optionally be filtered by the filters mentioned below.

    $ curl -u user:pass -d "" \
    >      https://api.snapbill.com/v1/currency/list.json

File: examples/currency.txt-1.json -

    {
      "code": 200,
      "type": "list",
      "page": 1,
      "numpages": 1,
      "class": "currency",
      "list": [
        {
          "code": "ZAR",
          "format": "R%.2f",
          "enabled": true
        }
      ]
    }

List Currencies Filters

Name Availability Description
state get The state (enabled or disabled) of the currencies. The default value of this argument is enabled.
code get The code (see above) of the countries.
page get The page of results to return.
perpage get The number of results per page to return.
developers/api/currency.1413616907.txt.gz · Last modified: 2014/10/18 07:21 by Jaco van Wyk