Documentation

Investments

Treasury securities and Certificates of Deposit through investment accounts.

The investments sub-module covers two asset classes: U.S. Treasury securities (Bills, Notes, Bonds) and Certificates of Deposit. Both are held inside an investment account, separate from the holder's checking and savings accounts. Custody and execution flow through the sponsor bank or its custodial partner — the platform records ownership and lifecycle.

Brokerage of securities is regulated under the Securities Act and Exchange Act, and offering investment products may require BD/RIA licensing depending on the model. The platform records and orchestrates; the licensed entity (sponsor bank or partner) executes and custodies.

Investment accounts

An investment account is a custodial wrapper around a holder's positions and cash balance. Cash flows in from a regular bank account, sits as uninvested cash, gets allocated to Treasuries or CDs, and (on maturity) returns to cash.

Create

POST/banking/investments/accountsJWT
{
  "holderId": "holder_abc",
  "linkedAccountId": "acc_checking_abc",
  "accountType": "individual"
}

Read

GET/banking/investments/accounts/{accountId}JWT

Returns cash balance, total portfolio value (cash + market value of holdings), and total cost basis.

Cash in and out

POST/banking/investments/accounts/{accountId}/depositJWT
{ "amount": 10000.00, "sourceAccountId": "acc_checking_abc" }
POST/banking/investments/accounts/{accountId}/withdrawJWT
{ "amount": 5000.00, "destinationAccountId": "acc_checking_abc" }

Both move money via internal book transfer. Withdrawals require sufficient cash balance — if your holdings are fully invested, you must redeem a holding first.

Transactions

GET/banking/investments/accounts/{accountId}/transactionsJWT

?limit=50. Returns the account's full transaction history: deposits, withdrawals, purchases, redemptions, interest payments.

Treasury securities

Treasuries are direct U.S. government debt. Three types:

TypeTermMechanism
T-Bill≤1 yearSold at discount; no coupons.
T-Note2–10 yearsPays coupons semi-annually.
T-Bond20–30 yearsPays coupons semi-annually.

Purchase

POST/banking/investments/treasuryJWT
{
  "accountId": "inv_acc_abc",
  "securityType": "T-Bill",
  "term": "13-week",
  "faceValue": 10000.00,
  "purchasePrice": 9875.50,
  "discountRate": 4.95,
  "yieldToMaturity": 5.05,
  "maturityDate": "2026-07-25"
}

For T-Notes and T-Bonds, include couponRate instead of discountRate. The platform debits cash, records the holding, and stores the maturity date.

Holdings

GET/banking/investments/accounts/{accountId}/treasuryJWT

?status=active. Lists Treasury positions for the account.

GET/banking/investments/treasury/{holdingId}JWT

Single holding with current valuation, unrealised gain/loss, and accrued interest.

Maturity

POST/banking/investments/treasury/{holdingId}/matureJWT

Processes the maturity event. The platform credits face value (Bills) or face + final coupon (Notes/Bonds) back to the account's cash balance and marks the holding matured. Run from a scheduler that watches for maturities each business day.

Certificates of Deposit

CDs are time-deposit products from the sponsor bank or partner banks. Fixed term, fixed rate, early-withdrawal penalty.

Purchase

POST/banking/investments/cdsJWT
{
  "accountId": "inv_acc_abc",
  "cdType": "standard",
  "term": "12-month",
  "principalAmount": 25000.00,
  "interestRate": 5.25,
  "issuingBank": "Sponsor Bank, N.A.",
  "autoRenew": false
}

cdType can be standard, jumbo, bump_up, step_up, etc. — controlled by the sponsor's product catalog. autoRenew: true rolls the CD at maturity into another CD of the same term at the prevailing rate.

Holdings

GET/banking/investments/accounts/{accountId}/cdsJWT

?status=active. Lists CDs.

GET/banking/investments/cds/{cdId}JWT

Single CD record with principal, rate, term, accrued interest, maturity date.

Maturity

POST/banking/investments/cds/{cdId}/matureJWT

Credits principal + accrued interest back to cash. If autoRenew is true, immediately purchases a new CD of the same term.

Early withdrawal

POST/banking/investments/cds/{cdId}/withdrawJWT

Redeems the CD before maturity. The sponsor's penalty schedule applies — typically forfeiture of N months of interest depending on the term length. The penalty is netted from the redemption proceeds.

Interest accrual

CD interest accrues daily but is held until maturity (or paid periodically depending on CD type). One admin endpoint drives the daily accrual:

POST/banking/investments/admin/accrue-cd-interestJWT

Schedule daily. Posts the day's accrual to the ledger and updates each active CD's accrued-interest counter.

Stats

GET/banking/investments/statsJWT

Portfolio aggregates across all investment accounts: total AUM, breakdown by asset class, average yield, maturities due in next 30/60/90 days.

What's not included

The investments module is intentionally narrow:

  • No equities, ETFs, or mutual funds — the platform's surface is limited to Treasuries and CDs at the sponsor.
  • No real-time market data — pricing is set at purchase and at maturity; mark-to-market is your responsibility if you need it.
  • No tax-form generation — 1099-INT (CD interest, T-Bill discounts) and 1099-OID (Treasury OID) reporting comes from the sponsor or your tax provider.