The WalletBalance object

Represents the balance of a merchant's wallet for a specific currency. The wallet balance is divided into different categories to help understand available and committed funds.

Fields

Field	Type	Description
currency REQUIRED	string	Three-letter ISO currency code
available REQUIRED	number	Amount available for withdrawal or payout
pending REQUIRED	number	Amount pending from recent transactions (not yet available)
reserved REQUIRED	number	Amount reserved for pending payouts or refunds
total REQUIRED	number	Total balance (available + pending + reserved)

Example

{
  "currency": "USD",
  "available": 1,
  "pending": 1,
  "reserved": 1,
  "total": 5000
}

Usage

const balances = await client.wallet.getBalances();
const usdBalance = balances.find(b => b.currency === 'USD');
console.log(`Available: ${usdBalance.available}, Pending: ${usdBalance.pending}`);