API status
  • Balances

Cash Balances

All cash balance related paths

get

Retrieve an account group's cash balance

Retrieve an account group's cash balance

account_group_idstring

required

Account group unique identifier.

Format
uuid

Responses

Response examples

Response

{
  "account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
  "currency": "EUR",
  "balance": "100",
  "locked_for_trading": "10",
  "pending_settlement": "10",
  "available_for_withdrawal": "80",
  "available_for_trading": "80"
}
webhook

Cash Balance events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Event type

Default
"CASH_BALANCE.UPDATED"
Enum
  • CASH_BALANCE.UPDATED
objectobject

required

account_group_idstring

required

Account group unique identifier.

Format
uuid
currencystring

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Enum
  • EUR
  • GBP
balancestring

required

Pattern
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
locked_for_tradingstring

required

Pattern
^[0-9]{0,63}(\.[0-9]{1,27})?$
pending_settlementstring

required

Pattern
^[0-9]{0,63}(\.[0-9]{1,27})?$
available_for_withdrawalstring

required

Pattern
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
available_for_tradingstring

required

Pattern
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a724",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "CASH_BALANCE.UPDATED",
  "object": {
    "account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
    "currency": "EUR",
    "balance": "100",
    "locked_for_trading": "10",
    "pending_settlement": "10",
    "available_for_withdrawal": "80",
    "available_for_trading": "80"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?