PayGuard REST API
Base URL: https://payguard.prinsoft.cloud
Authentication
All API calls require session authentication. Login first via POST /auth/login.
Government Payroll
| Method | Endpoint | Description |
|---|
| POST | /gov-payroll/process | Submit payroll data (JSON). Returns net pay + MFI settlements. |
| POST | /gov-payroll/upload | Upload payroll CSV file. |
| GET | /gov-payroll/download/net-pay/<batch_id> | Download net pay schedule CSV. |
| GET | /gov-payroll/download/mfi-settlement/<batch_id> | Download MFI settlement CSV. |
| GET | /gov-payroll/template | Download CSV template. |
Mifos X Integration
| Method | Endpoint | Description |
|---|
| POST | /mifos/test-connection | Test Mifos instance connectivity. |
| POST | /mifos/verify-loan | Verify loan exists. Body: {"loan_id": 1, "mfi_id": "..."} |
| POST | /mifos/post-repayment | Post loan repayment. Body: {"loan_id": 1, "amount": 150} |
| POST | /mifos/sync-batch/<batch_id> | Push all batch transactions to Mifos. |
| GET | /mifos/portfolio | Get Mifos portfolio overview. |
Reconciliation
| Method | Endpoint | Description |
|---|
| POST | /reconciliation/upload | Upload remittance CSV. Form: mfi_id, payroll_period, file. |
| GET | /reconciliation/disputes/<batch_id> | Get unmatched items. |
| GET | /reconciliation/download-disputes/<batch_id> | Download dispute CSV. |
Statistics
| Method | Endpoint | Description |
|---|
| GET | /api/stats | Platform statistics (employees, deductions, MFIs, volume). |
| GET | /health | Health check (public). |
Gov Payroll JSON Example
{
"payroll_period": "2026-06",
"employees": [
{"employee_number": "EMP001", "name": "John Moyo", "gross_salary": 450.00},
{"employee_number": "EMP002", "name": "Jane Dube", "gross_salary": 380.00}
]
}