Skip to main content
A Wallet holds the cash balance for an investment account. Deposits flow into the wallet, trades debit from it, and withdrawals send funds back to the user’s bank account. Every account gets a wallet automatically when created.

​
Wallet types

Bluum supports three wallet types, depending on your integration model:
TypeBalance sourceBest for
HostedBluum manages the balance directlyMost integrations — Bluum tracks all cash
BYO (Bring Your Own)Your system provides the balance via an endpointPartners who manage their own ledger
OmnibusComputed from an immutable double-entry ledgerPartners needing full audit trail
Most integrations use the Hosted wallet type. BYO and Omnibus are available for partners with specific operational requirements.

​
How money flows

Bank Account ──deposit──► Wallet ──buy order──► Positions
                            ▲                      │
                            │                      │
                        sell order ◄───────────────┘
                            │
                     ──withdrawal──► Bank Account
  1. Deposit — Money enters the wallet from a linked bank account
  2. Buy order — Wallet balance decreases; a hold is placed during execution
  3. Sell order — Proceeds return to the wallet after the order fills
  4. Withdrawal — Money leaves the wallet to the user’s bank account

​
Wallet holds

When an order is placed, Bluum creates a hold on the wallet to reserve funds for the trade. This prevents the user from spending the same money twice.
Hold statusMeaning
ACTIVEFunds reserved, order in progress
RELEASEDOrder canceled, funds returned to available balance
CAPTUREDOrder filled, funds debited
EXPIREDHold expired (order timed out)

​
Balance fields

FieldDescription
balanceTotal wallet balance (available + held)
available_balanceBalance available for new trades or withdrawals
reserved_balanceBalance reserved by active holds
balance = available_balance + reserved_balance

​
Transactions

Every wallet operation creates a transaction record:
Transaction typeDescription
depositFunds received from bank account
withdrawalFunds sent to bank account
buyFunds debited for order execution
sellProceeds credited from order fill
feeTrading commission or platform fee
# Get wallet details
curl -X GET "$BASE_URL/accounts/$ACCOUNT_ID/wallets" \
  -H "Authorization: Basic $AUTH"

# Get transaction history
curl -X GET "$BASE_URL/accounts/$ACCOUNT_ID/transactions" \
  -H "Authorization: Basic $AUTH"

​
Key endpoints

MethodPathDescription
GET/accounts/{account_id}/walletsGet wallet details and balance
GET/accounts/{account_id}/transactionsList wallet transactions