Upvest · JSON Structure

Investment Api Cash Balance Structure

Cash balance information for an account.

Type: object Properties: 5
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

CashBalance is a JSON Structure definition published by Upvest, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

account_id available pending total currency

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-structure/investment-api-cash-balance-structure.json",
  "name": "CashBalance",
  "description": "Cash balance information for an account.",
  "type": "object",
  "properties": {
    "account_id": {
      "type": "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"
    }
  }
}