Balance

GET /balance

Returns your financial summary for the current period.

Response — 200 OK
{
  "total_success": "8500.00",
  "total_pending": "1200.00",
  "total_failed": "450.00",
  "total_expired": "150.00",
  "count_success": 87,
  "count_failed": 23,
  "commission_percent": 40,
  "net_amount": "3400.00",
  "period_start": "2026-03-01T00:00:00.000Z",
  "period_end": "2026-03-31T23:59:59.000Z"
}

Fields

FieldDescription
total_successSum of all successful payments
total_pendingSum of payments in progress
total_failedSum of declined payments
total_expiredSum of expired payments
count_successNumber of successful transactions
count_failedNumber of declined transactions
commission_percentYour payout percentage
net_amountAmount due to you: total_success × commission_percent / 100