“Spend account” and “cash balance account” are the same thing.In the API, a spend account is represented by the
UserCashBalance type, and the operations are named ...UserCashBalance (e.g., createUserCashBalance). This page uses “spend account” throughout.Balances
Every spend account tracks three balances, all returned as strings:
A user can hold multiple spend accounts, and one is flagged as the default (
isDefault: true).
What You Can Do
Account Lifecycle
A spend account moves through a small set of statuses (UserCashBalanceStatus): typically ACTIVE, and CLOSED once closed.
Closing an account is more than a status change. When you close a spend account with a remaining available balance, that balance must be moved to another spend account. If any virtual cards are funded by the account being closed, you must either reassign them to a new funding source or lock them as part of the same request.
Closing an account requires you to resolve its balance and dependent cards.If the account still holds an available balance, provide
transferUserCashBalanceId to move it. If virtual cards are tied to the account, provide either newFundingSource to reassign them or lockAllVirtualCards to lock them. See Close Spend Accounts for the full input reference.How Spend Accounts Fit In
Spend accounts sit at the center of a user’s wallet:- Fund them with Deposit Funds or move money between them with Transfer Funds Internally.
- Spend from them on gift cards and virtual cards.
- Check balances anytime with Check Account Balance or the spend account queries above.
Requirements
Listing spend accounts requires theLIST_PAYMENT scope. Creating, editing, and closing spend accounts require the MANAGE_PAYMENT scope. Make sure your user access token carries the correct scope before calling these operations.
Want to learn more? Speak with our experts for more info or to request a demo.