Skip to main content

Wallet Status

Retrieve your workspace's current prepaid balance and low-balance alert configuration.


Endpoint

GET/v1/wallet/status

Required permission: wallet:get


Response

FieldTypeDescription
balanceIntegerAvailable prepaid balance in ₦ (stored as whole kobo units).
lowThresholdIntegerThe balance level that triggers a low-balance alert in ₦.
lowBalanceAlertBooleanWhether the low-balance alert is currently active.

{
"statusCode": 200,
"message": "Success",
"data": {
"balance": 100000,
"lowThreshold": 10000,
"lowBalanceAlert": true
}
}