Retrieving cash balance

Prerequisites

In order to retrieve a cash balance, you need to ensure that the user is onboarded and account group is set up.

The cash balance for an account group can be retrieved by calling

GET /account_groups/{account_group_id}/payments/cash_balance.

Example 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"
}

Next steps

Once the cash balance is confirmed to be sufficiently funded, you are ready to implement order requests. Alternatively, you can also set up your users to register a reference bank account to allow them to withdraw funds.