Upvest · Schema

CashBalance

Cash balance information for an account.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name Type Description
account_id string The account identifier.
available string The available cash balance as a decimal string.
pending string The pending cash amount as a decimal string.
total string The total cash balance as a decimal string.
currency string The balance currency.
View JSON Schema on GitHub

JSON Schema

investment-api-cash-balance-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-cash-balance-schema.json",
  "title": "CashBalance",
  "description": "Cash balance information for an account.",
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The account identifier.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "available": {
      "type": "string",
      "description": "The available cash balance as a decimal string.",
      "example": "example-value"
    },
    "pending": {
      "type": "string",
      "description": "The pending cash amount as a decimal string.",
      "example": "example-value"
    },
    "total": {
      "type": "string",
      "description": "The total cash balance as a decimal string.",
      "example": "example-value"
    },
    "currency": {
      "type": "string",
      "description": "The balance currency.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    }
  }
}