Skip to content

Wallet Balance

Get current wallet balance for the authenticated user

Endpoint: GET https://api.uncash.io/api/v1/wallet/balance

Response

Success Response

FieldTypeDescription
successbooleanIndicates if the request was successful
messagestringSuccess message

Data Object

FieldTypeDescription
balancenumberCurrent wallet balance in USD
updated_atstringISO 8601 timestamp of last balance update

Request Example

bash
curl -X GET https://api.uncash.io/api/v1/wallet/balance \
  -H "Authorization: Bearer uc_your_api_token_here"
javascript
const response = await fetch('https://api.uncash.io/api/v1/wallet/balance', {
  headers: {
    'Authorization': 'Bearer uc_your_api_token_here'
  }
});

const data = await response.json();
python
import requests

url = "https://api.uncash.io/api/v1/wallet/balance"
headers = {"Authorization": "Bearer uc_your_api_token_here"}

response = requests.get(url, headers=headers)
data = response.json()

Response Example

json
{
  "success": true,
  "data": {
    "balance": 1500.75,
    "updated_at": "2025-08-03T10:00:00.000Z"
  },
  "message": "Wallet balance retrieved successfully"
}

Notes

Real-time Balance: The wallet balance is updated in real-time when cards are created, topped up, or closed. This endpoint always returns the current balance.

Error Responses

Wallet Not Found

json
{
  "success": false,
  "message": "Wallet not found",
  "timestamp": "2025-08-03T10:00:00.000Z"
}

UnCash API Documentation