List currencies

GET 
/api/v3/currency

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

currency_id integer

Currency ID #

currency string

Deprecated

name string

Currency name

iso4217 string

ISO 4217 currency code

symbol string

Currency symbol

rounding integer

Number of decimal places to round currency fractions to

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "currency_id": 0,
      "currency": "string",
      "name": "string",
      "iso4217": "string",
      "symbol": "string",
      "rounding": 0
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "currency_id": 1,
      "currency": "United States dollar",
      "iso4217": "USD",
      "symbol": "$",
      "rounding": "2"
    },
    {
      "currency_id": 2,
      "currency": "Canadian dollar",
      "iso4217": "CAD",
      "symbol": "CAD$",
      "rounding": "2"
    },
    {
      "currency_id": 3,
      "currency": "Pound sterling",
      "iso4217": "GBP",
      "symbol": "£",
      "rounding": "2"
    },
    {
      "currency_id": 4,
      "currency": "Euro",
      "iso4217": "EUR",
      "symbol": "€",
      "rounding": "2"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...