Retrieve Remita Collections

Overview

Retrieves a paginated list of individual Remita collection records. Supports filtering by batch ID, loan request, posting status, and date range.

Command Details

• Command: RetrieveRemitaCollectionsQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
pageNumber	int	No	Page number for pagination (default: 1)
pageSize	int	No	Number of records per page (default: 10)
batchId	long	No	Filter by batch ID
loanRequestId	long	No	Filter by loan request ID
isPosted	bool	No	Filter by posting status
isExport	bool	No	Export mode for bulk retrieval (default: false)
startDate	string	No	Filter collections created on or after this date (ISO 8601)
endDate	string	No	Filter collections created on or before this date (ISO 8601)

Try It Out

POST/api/bpm/cmdRetrieveRemitaCollectionsQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveRemitaCollectionsQuery", "data": { "pageNumber": 1, "pageSize": 10, "isExport": false, "startDate": "2026-01-01", "endDate": "2026-03-31" } }

Response Structure

{
  "success": true,
  "data": {
    "items": [
      {
        "id": 7001,
        "batchId": 3001,
        "loanRequestId": 5001,
        "amount": 50000.00,
        "status": "Successful",
        "isPosted": true,
        "createdAt": "2026-03-08T10:30:00Z"
      },
      {
        "id": 7002,
        "batchId": 3001,
        "loanRequestId": 5002,
        "amount": 75000.00,
        "status": "Successful",
        "isPosted": false,
        "createdAt": "2026-03-08T10:30:00Z"
      }
    ],
    "totalCount": 24,
    "pageNumber": 1,
    "pageSize": 10
  },
  "message": "Collections retrieved successfully"
}

Related Operations

• Post Collection — Post a collection transaction
• Reverse Collection — Reverse a posted collection
• Retrieve Collection Batches — List batch records