Interface: BalanceResult

Defined in: packages/pesa/src/types/account.ts:21

Result of a balance inquiry — returns available balances across all active currencies in the provider's wallet.

Use pesa.getBalance() to verify available funds before initiating disbursements or to display wallet health in dashboards.

Since

0.2.0

Example

if (pesa.getBalance) {
  const { balances } = await pesa.getBalance();
  const tzsBalance = balances.find((b) => b.currency === 'TZS');
  console.log(`Available: TZS ${tzsBalance?.amount ?? 0}`);
}

Properties