Core Balance

Retrieve a Core Balance

Changed on
get/v2/core_balances/{id}

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/core_balances/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:core_balance_xyz123

Response

A Core Balance object.

idstring
core_account_idstring
namestring
status'active' | 'inactive' | 'closed'
type'deposit'
currency_code'USD'

A three-letter currency code as defined in ISO 4217.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "core_balance_xyz123",
  "core_account_id": "core_account_xyz123",
  "name": "Consumer FBO",
  "status": "active",
  "type": "deposit",
  "currency_code": "USD",
  "amounts": {
    "spendable": 65095000,
    "cash_available": 24995000,
    "posted": 25000000,
    "sweeps": 40000000,
    "holds": 5000
  },
  "overdraft": {
    "limit": 100000,
    "unused": 100000
  },
  "interest": {
    "rate": "1.000000",
    "accrued": 12450
  },
  "created_at": "2025-09-01T00:00:00Z",
  "updated_at": "2026-03-21T12:00:00Z"
}

Changes