Wallet Status
Retrieve your workspace's current prepaid balance and low-balance alert configuration.
Endpoint
GET
/v1/wallet/statusRequired permission: wallet:get
Response
| Field | Type | Description |
|---|---|---|
balance | Integer | Available prepaid balance in ₦ (stored as whole kobo units). |
lowThreshold | Integer | The balance level that triggers a low-balance alert in ₦. |
lowBalanceAlert | Boolean | Whether the low-balance alert is currently active. |
{
"statusCode": 200,
"message": "Success",
"data": {
"balance": 100000,
"lowThreshold": 10000,
"lowBalanceAlert": true
}
}