Retrieve your current account balance
The Balance API allows you to retrieve your current account balance in real-time.
Real-time account balance and currency information.
curl -X GET "https://livepay.me/api/v1/user-balance.php" \ -H "Authorization: Bearer <--your-secret-key-->" \ -H "Content-Type: application/json"
{
"status": "success",
"user": {
"first_name": "Kayemba",
"second_name": "Ronald",
"username": "kayemba-ronald-OQM5SB",
"balance": "0.00",
"currency": "UGX"
}
}
This endpoint requires Bearer token authentication using your Secret Key in the Authorization header.
Bearer <--your-secret-key-->
application/json
| Field | Type | Description |
|---|---|---|
status
|
String | Request status (success/error) |
user
|
Object | User information and balance |
user.first_name
|
String | User's first name |
user.second_name
|
String | User's second name |
user.username
|
String | User's unique username |
user.balance
|
String | Current account balance |
user.currency
|
String | Currency code (UGX) |
The balance returned is real-time and reflects the current state of your account.
Always use your Secret Key in secure environments. Never expose it in client-side code or public repositories.