v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

Balances

List balances

Retrieves a list of balances for the given account

get/balances

Query parameters

currencystring

Example:GBP

Filter for one or more currencies. By default all currencies will be returned when this field is omitted.

Headers

Accountstring

Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this to list balances for a specific sub account)

Response

Successfully retrieved the balances for the account

Example response

{
  "items": [
    {
      "currency": "GBP",
      "pending": {
        "amount": 500
      },
      "cleared": {
        "amount": 500
      },
      "available": {
        "amount": 500
      },
      "lastUpdatedTimestamp": 1470989538
    }
  ]
}