MPPFinanceDocsv0.1
SDK Reference/getBalance()

getBalance()

Returns the current balance of the agent wallet, broken down by available, reserved, and total.

Signature

client.getBalance(): Promise<Balance>

Returns

FieldTypeDescription
availablenumberSpendable balance in USD cents
reservednumberBalance reserved by active cards
totalnumberTotal wallet balance
networkstringSettlement network
currencystringDisplay currency

Example

balance.ts
const balance = await client.getBalance()

console.log(`Available: $${(balance.available / 100).toFixed(2)}`)
console.log(`Reserved:  $${(balance.reserved  / 100).toFixed(2)}`)
console.log(`Total:     $${(balance.total     / 100).toFixed(2)}`)