GET
/
wallets
/
balance

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 in outlet.collectionWallet.walletId / outlet.depositWallet.walletId).

Balance fields

  • ledgerBalance is the authoritative balance — what the wallet has after all settled debits and credits.
  • availableBalance is ledgerBalance minus active liens, holds, and in-flight debits.

Authorizations

x-api-key
string
headerrequired
x-api-secret
string
headerrequired

Query Parameters

walletId
string

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

200 - application/json
status
boolean
required

Indicates if the request was successful

statusCode
integer
required

HTTP status code of the response

data
object[]
required
message
string
required

Response message describing the result of the request