View Currency

GET /currencies/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/currencies/{id}

Retrieves the details of a Currency if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique id of the currency. Example - CNY


Example: CNY
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ currency ]
An array of all created items.
Currency
Name
Description
codestring
Three-letter, uppercase currency code.


Example: CNY
idstring
A unique identifier generated by the Ocamba platform.


Example: CNY
namestring
Currency name.


Example: Chinese Yuan Renminbi
ratefloat
An exchange rate.


Example: 6.3848
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the currency id, list the currencies to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
          "id": "EUR",
          "code": "EUR",
          "name": "Euro",
          "rate": 0.94572
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "CNY",
      "code": "CNY",
      "name": "Chinese Yuan Renminbi",
      "rate": 6.3848
    }
  ]
}