The Money Map
Balance Types
An account can hold up to four kinds of balance. Spend accounts are the only kind a user can have more than one of.
The sum of these is the account’s available Fluz balance — the total that can be applied toward funding a payment.
The same balance appears under more than one name.The gift card balance is returned as
giftCardCashBalance on getWallet and as gift_card_prepayment_balance_* on the Transaction type. The rewards balance is rewardsBalance on getWallet and seat_balance_* on Transaction. These are aliases, not separate pots of money.Spend Accounts Hold the Balance
A spend account —UserCashBalance in the API — is a named container for cash. A user can open several and give each one a nickname, so funds can be separated by purpose without opening separate Fluz accounts.
Each spend account carries its own independent balance. Money in one is not spendable from another until it is moved with an internal transfer.
Every spend account tracks three figures, all returned as strings:
Getting Funds In
There are two fundamentally different directions money can move into a balance, and the distinction matters for how you build.Pull — you initiate
Your application calls
depositCashBalance and Fluz pulls funds from a funding source the user has already linked: a bank account, bank card, or digital wallet. You control the timing and the amount.Push — someone else initiates
An outside party sends money to a virtual account number attached to a spend account. Fluz posts it as a deposit when it arrives. You do not control the timing or the amount.
A virtual account number is an address, not a balance.Each spend account can have one or more virtual account numbers — real routing and account number pairs. Anything sent to them credits that spend account. Multiple VANs on one account all feed the same balance; they exist so you can tell a payroll credit apart from a customer payment. See Virtual Account Numbers.
Moving and Removing Funds
Reading Balances
getWallet returns the account’s balances in one call, alongside the user’s linked funding sources.
userCashBalances is paginated and returns accounts ordered by creation date, most recent first. To fetch a single spend account, use getUserCashBalanceById.
The reserve balance is held by Fluz rather than directed by the user. Its current state is visible on each transaction through the reserve_balance_available_balance and reserve_balance_total_balance snapshot fields described below.
Reading the Ledger
Balances tell you where things stand.getTransactions tells you how they got there. To see the ledger for one specific spend account, filter by its ID.
Scopes required: LIST_PAYMENT and LIST_PURCHASES
Variables
Only spend accounts can be filtered by ID.
TransactionFilterInput exposes userCashBalanceId, but there is no equivalent filter for the rewards, gift card, or reserve balances. To isolate activity on those, retrieve transactions over a date range and filter on the corresponding is_..._affected flag.getTransactions is capped at 20 records per page. Check hasNextPage and advance offset to page through. See Get All Transactions for the complete filter reference.
Scopes at a Glance
Where to Go Next
Spend Accounts
Create, rename, and close the accounts that hold the balance.
Virtual Account Numbers
Receive RTP, FedNow, wire, and ACH credits directly into a spend account.
Deposit Funds
Pull money in from a linked bank account or card.
Withdraw Funds
Move money out to an external account.
Transfer Between Accounts
Move balance between a user’s own spend accounts.
Get All Transactions
The full ledger, with filtering and pagination.
Want to learn more? Speak with our experts for more info or to request a demo.