Balances
What SkanPay holds for you, per currency, derived from the ledger.
GET/v1/balances
curl https://api.skanpay.website/v1/balances \
-H "Authorization: Bearer $SKANPAY_SECRET_KEY"{
"object": "list",
"data": [
{ "currency": "UGX", "available": "1250000", "pending": "48750" }
]
}Each balance
currencyenum- One row per currency you have transacted in.
availablestring- Minor units you can spend on payouts and withdrawals now. Held funds are already excluded.
pendingstring- Collected from charges, not yet released. Each charge's net moves to available one day after it succeeds.
What changes each balance
| Event | pending | available |
|---|---|---|
| Charge succeeds | + net | |
| One day later | − net | + net |
| Deposit succeeds | + amount | |
| Payout or withdrawal requested (hold) | − (amount + fee) | |
| …it fails or is rejected | + (amount + fee) | |
| Charge reversed before release | − net | |
| Charge reversed after release | − net |
Balances are derived from ledger entries, never edited directly. Every movement can be traced to a transaction with GET /v1/transactions/:id.