Skip to main content

Retrieve Remita Loan Requests

Overview​

Retrieves a paginated list of Remita loan requests with optional filtering by organisation and date range. Supports export mode for bulk data extraction.

Command Details​

  • Command: RetrieveRemitaLoanRequestsQuery
  • Type: Query

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
pageNumberintNoPage number for pagination (default: 1)
pageSizeintNoNumber of records per page (default: 10)
organisationIdlongNoFilter by organisation
isExportboolNoExport mode for bulk retrieval (default: false)
startDatestringNoFilter loans created on or after this date (ISO 8601)
endDatestringNoFilter loans created on or before this date (ISO 8601)

Try It Out​

POST/api/bpm/cmdRetrieveRemitaLoanRequestsQuery
Request Body

Response Structure​

{
"success": true,
"data": {
"items": [
{
"id": 5001,
"accountName": "John Doe",
"loanAmount": 5000000.00,
"tenure": 12,
"status": "Disbursed",
"createdAt": "2026-01-15T10:30:00Z"
},
{
"id": 5002,
"accountName": "Jane Smith",
"loanAmount": 2500000.00,
"tenure": 6,
"status": "PendingApproval",
"createdAt": "2026-02-20T09:15:00Z"
}
],
"totalCount": 42,
"pageNumber": 1,
"pageSize": 10
},
"message": "Loan requests retrieved successfully"
}