Dashboard Overview
Ledger Balance
Loading...
Total Transactions
Loading...
Last Transaction
Loading...
Recent Transactions
| Reference ID | Amount | Status | Time |
|---|---|---|---|
| Loading... | |||
Fund Ledger
Credit the party ledger (ID: 24) with a specified amount.
Current Balance
Loading...
Transaction History
| Log ID | User | Reference | Amount | Status | IP | Time |
|---|---|---|---|---|---|---|
| Loading... | ||||||
API Documentation
Authentication
All endpoints except /api/auth/token require a Bearer token in the Authorization header:
Authorization: Bearer <your-jwt-token>
1. Generate Token
POST
/api/auth/token
// Request
{
"clientId": "funding_admin",
"clientSecret": "funding_secret_2024"
}
// Response (200)
{
"error": false,
"token": "eyJhbGci...",
"expiresIn": "1h",
"user": { "id": 1, "name": "Funding API Admin", "role": "admin" }
}
2. Process Funding
POST
/api/funding/process
// Request (with Bearer token)
{
"amount": 1000.00,
"referenceID": "TXN-2024-001"
}
// Success Response (200)
{
"error": false,
"message": "Successfully funded ₦1,000.00",
"referenceID": "TXN-2024-001",
"amount": 1000,
"partyID": 24
}
// Error Response (500)
{
"error": true,
"message": "Funding failed ₦1,000.00"
}
3. Get Balance
GET
/api/funding/balance
// Response (200)
{
"error": false,
"message": "Balance retrieved successfully",
"partyID": 24,
"balance": 20935441.72,
"formatted": "₦20,935,441.72",
"lastUpdated": "2024-01-15"
}
4. Get Stats
GET
/api/funding/stats
// Response (200)
{
"error": false,
"message": "Stats retrieved successfully",
"balance": 20935441.72,
"formatted": "₦20,935,441.72",
"transactionCount": 38,
"lastTransaction": { ... }
}
5. Get History
GET
/api/funding/history?limit=20
// Response (200)
{
"error": false,
"message": "History retrieved successfully",
"count": 20,
"transactions": [ ... ]
}
6. Verify Token
GET
/api/auth/verify
// Response (200)
{
"error": false,
"valid": true,
"user": { "id": 1, "name": "Funding API Admin", "role": "admin" }
}
7. Health Check
GET
/api/health
// Response (200)
{
"error": false,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z"
}