Wallet Balance
Get company wallet fund balances by currency.
GET
/api/v1/wallet/balance?currency_code=USDDescription
Returns total, available, and used funds.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| currency_code | string | No | Currency code (default USD). |
Response
| Field | Type | Description |
|---|---|---|
| success | boolean | Whether the request succeeded. |
| message | string | Human-readable status message. |
| data | object | Balance details. |
| data.currency_code | string | Currency code (e.g. USD). |
| data.total_funds | string | Formatted total wallet balance. |
| data.available_funds | string | Formatted available balance. |
| data.used_funds | string | Formatted used balance. |
Related Endpoints
Did this page help you?
Request
curl -X GET https://uat.unduit.com/api-exposed/api/v1/wallet/balance?currency_code=USD \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response
{
"success": true,
"message": "Wallet balance retrieved successfully",
"data": {
"currency_code": "USD",
"total_funds": "$10,000.00",
"available_funds": "$8,500.00",
"used_funds": "$1,500.00"
}
}