Retrieve balance
GET /v1/balance?currency=USD returns wallet figures for the environment selected by your API key.
Key points
- available_balance is the ledger balance usable for refunds; withdrawable_balance is the amount eligible for payout.
- frozen_balance tracks reserved funds. Cumulative fields include total_revenue, total_fee, total_refund, and total_payout.
- Live withdrawable funds depend on upstream settlement and reconciliation, not only the visible ledger balance.
Example
bash
curl "https://api.kukopay.com/v1/balance?currency=USD" \
-H "X-Api-Key: $KUKOPAY_API_KEY"