Get Balance
Retrieves the current balance of a specified wallet, allowing you to check the available funds in real-time. Without walletId the response covers all wallets the caller can see; with walletId the response is scoped to that single wallet.
Returns the current ledger and available balances for the authenticated user’s wallets.
Scoping by walletId
Pass ?walletId=<id> to scope the response to a single wallet.
walletId accepts either:
- A 10-digit NUBAN for primary wallets (e.g.
8000000942), or - A
wal_<26-char-ULID>identifier for outlet wallets (returned inoutlet.collectionWallet.walletId/outlet.depositWallet.walletId).
Balance fields
ledgerBalanceis the authoritative balance — what the wallet has after all settled debits and credits.availableBalanceisledgerBalanceminus active liens, holds, and in-flight debits.
Authorizations
Query Parameters
Selects which of your wallets to read. Accepts either the 10-digit NUBAN of a primary wallet (e.g. 8000000942) or the wal_<26-char-ULID> identifier of an outlet wallet (returned in outlet.collectionWallet.walletId / outlet.depositWallet.walletId). Wallets that do not belong to the calling Business return an empty result.
Response
Indicates if the request was successful
HTTP status code of the response
Response message describing the result of the request