Skip to main content
View as Markdown

Wallet

Manage wallet balances, transactions, ledger entries, commissions, and fees. Access via zenpays.wallet.

Balance​

getBalance​

const balance = await zenpays.wallet.getBalance('INR')
// Or get all: const balances = await zenpays.wallet.getBalance()

getAllBalances​

const balances = await zenpays.wallet.getAllBalances()

Transactions​

listTransactions​

const { data } = await zenpays.wallet.listTransactions({
  type: 'credit',
  from: '2024-01-01',
  limit: 50,
})

getTransaction​

const txn = await zenpays.wallet.getTransaction('wtxn_xxx')

Adjustments​

listAdjustments​

const adjustments = await zenpays.wallet.listAdjustments()

createAdjustment​

const adjustment = await zenpays.wallet.createAdjustment({
  amount: 100,
  currency: 'INR',
  type: 'credit',
  reason: 'Manual adjustment',
})

Ledger​

getLedgerEntries​

const entries = await zenpays.wallet.getLedgerEntries({
  account: 'merchant_balance',
  from: '2024-01-01',
  to: '2024-12-31',
  limit: 100,
})

getLedgerBalances​

const balances = await zenpays.wallet.getLedgerBalances()

getReserveBalances​

const reserves = await zenpays.wallet.getReserveBalances()
// Returns: [{ currency, reserved, available }]

getDailyLedgerSummary​

const summary = await zenpays.wallet.getDailyLedgerSummary('2024-06-15')
// Returns: { date, totalDebits, totalCredits, netChange, byAccount }

getLedgerAnalytics​

const analytics = await zenpays.wallet.getLedgerAnalytics('30d')
// Returns: { period, totalVolume, trend }

Commissions​

getCommissions​

const commissions = await zenpays.wallet.getCommissions({
  from: '2024-01-01',
  to: '2024-12-31',
  type: 'payment',
})

getCommissionAnalytics​

const analytics = await zenpays.wallet.getCommissionAnalytics('30d')
// Returns: { period, totalCommission, byType, trend }

Fees​

calculateFees​

const fees = await zenpays.wallet.calculateFees({
  amount: 1000,
  currency: 'INR',
  type: 'payment',
})

getFeeConfig​

const config = await zenpays.wallet.getFeeConfig()
// Returns: { paymentFees, payoutFees, refundFees, currency }