GET
Wallets/wallets/{walletId}/balanceGet wallet balance
Returns cached, held, pending and available balances with verification time.
Access tiercustomer_or_businessRate limit60/minIdempotencynoneAuthenticationBearerAuth
Source
LuxApi/app/Http/Controllers/Api/WalletApiController.php::balanceLuxPayProjects @ 146e98baa44eParameters
X-Request-IDheaderClient correlation identifier. LuxPay may generate one when omitted.
Example:req_01J...walletIdpathNumeric wallet identifier.
Example:42Code examples
The displayed sandbox host is a placeholder until an official host is provisioned. Never paste a production token into a public browser.
curl --request GET \
--url 'https://sandbox-api.luxpay.example/v1/wallets/42/balance' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'Responses
200Successful response.
statusboolean
Example:
truedataWalletBalance
{
"status": true,
"data": {
"wallet_id": 42,
"account_number": "C-YER-00000042",
"currency_code": "YER",
"available_balance": 4500,
"cached_balance": 5000,
"held_balance": 500,
"pending_balance": 0,
"balance_verified_at": "2026-07-16T12:00:00Z"
}
}