Wallet & Billing
Firm wallet balance, transaction history and monthly billing summary. Base route: /api/v1/wallet
Endpoints
| Method | Route | Permission | Description |
|---|---|---|---|
| GET | /api/v1/wallet/balance | Wallet:View | Current wallet balance |
| GET | /api/v1/wallet/transactions | Wallet:View | Transaction history with filters |
| GET | /api/v1/wallet/monthly-summary | Wallet:View | Monthly billing summary |
GET
/api/v1/wallet/balance
JSON Response
{
"isSuccess": true,
"data": {
"balance": 1250.50,
"currency": "USD",
"lastUpdated": "2026-05-27T10:00:00Z"
}
}GET
/api/v1/wallet/transactions
Query Parameters
| Parameter | Type | Description |
|---|---|---|
month | int? | Filter by month (1–12) |
year | int? | Filter by year |
types | enum[]? | Transaction types: Debit, Credit, Discount, Adjustment |
GET
/api/v1/wallet/monthly-summary
Query Parameters
| Parameter | Type | Required |
|---|---|---|
year | int | ✓ |
month | int | ✓ |
Transaction Types
| Type | Description |
|---|---|
Debit | Usage charge (messages sent, campaign dispatch) |
Credit | Top-up credited by admin |
Discount | Discount applied by admin |
Adjustment | Manual balance adjustment |