API reference
GET
/account/balanceRead the account balance
Read the shared account balance in this environment
Overview
Read the shared account wallet balance for the authenticated environment. All application keys on an account share this balance. Test funds are isolated from the real wallet.
Available, pending and locked values are decimal strings in UGX. Sufficient balance does not guarantee provider availability.
Example request
curl https://api.nuepay.net/v1/account/balance \
-H "Authorization: Bearer $NUEPAY_TEST_KEY"Example response
{
"data": {
"account_number": "YOUR_ACCOUNT_NUMBER",
"currency": "UGX",
"available": "1000000.00",
"pending": "0.00",
"locked": "0.00",
"mode": "test",
"livemode": false
}
}Examples omit timestamps for readability. Use POST /quotes to confirm current fees rather than hard-coding these examples.
Response fields
| Field | Type | Details |
|---|---|---|
account_number | string | See the response and related guide. |
currency | string | UGX |
available | string | See the response and related guide. |
pending | string | See the response and related guide. |
locked | string | See the response and related guide. |
mode | string | live, test |
livemode | boolean | See the response and related guide. |
HTTP status codes
| Status | Meaning |
|---|---|
200 | UGX available, pending and locked decimal strings. Test balances are isolated from real wallets. |
201 | Invalid credentials. |
202 | Access unavailable or operation paused. |
203 | Resource not found in this application and environment. |
204 | Idempotency conflict, insufficient funds, or payout setup required. |
205 | Invalid input; inspect errors and code. |
206 | Rate limit exceeded. |
207 | Live provider unavailable; accepted payments can still be read or retried. |
Errors contain a stable code and support request_id. See error handling for recovery guidance.