Currencies

Currencies describe the available currencies within the system. Providers and customers provide their currency. All pricing details also describe the currency.

Currency

code	string <iso-4217> A 3-letter currency code.
name	string [ 1 .. 255 ] characters Name of currency.

{"code": "EUR",
"name": "Euro"
}

Retrieve all currencies

Retrieve a list of supported currencies.

SecurityOAuth2

Request

query Parameters

limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
offset	integer <int64> >= 0 Default: 0 Offset of resources in result.

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
offset	integer <int64> >= 0 Default: 0 The applied value of the offset query parameter on the resources in result.
property name* additional property	any

Array of objects (Currency) >= 0 items

List of currencies.

Array (>= 0 items)

code	string <iso-4217> A 3-letter currency code.
name	string [ 1 .. 255 ] characters Name of currency.

total

integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/system/currencies

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"code": "EUR",
"name": "Euro"
}
],
"total": 3255
}

Retrieve currency

Retrieve a single currency by its code.

SecurityOAuth2

Request

path Parameters

currency-code

required

string <iso-4217>

Code of the currency to manage.

Example: EUR