Retrieve the test or live developer wallet balance.
Retrieve the wallet balance for the API key's environment.
GET /v1/balance
| Property | Value |
|---|---|
| Scope | BALANCE_READ |
| Price | Free |
| Idempotency-Key | Not required |
| Test balance | ₦100,000 |
Request
curl "https://api.idyntic.getapexly.com/v1/balance" \
-H "Authorization: Bearer id_live_your_key"HTTP 200: balance returned
{
"success": true,
"message": "Wallet balance retrieved successfully",
"data": {
"balance": 5000,
"currency": "NGN",
"unit": "naira",
"environment": "live"
}
}balance is returned in naira.
HTTP 401: unauthorized
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Provide a valid API key with the BALANCE_READ scope.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}HTTP 429: rate limit exceeded
{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Retry after the current rate limit window resets.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Read Retry-After before retrying. Balance errors do not include a billing object.