Retrieve Disbursements

Overview

Retrieves a paginated list of individual disbursement records. Each record represents a single fund transfer that was processed as part of a batch. Use this to track the status and outcome of individual transfers.

Command Details

• Command: RetrieveDisbursementsQuery
• Type: Query (read operation)
• Permissions required: Disbursement View

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
pageNumber	int	No	Page number (default: 1)
pageSize	int	No	Items per page (default: 10)
isExport	bool	No	Export mode (default: false)
startDate	string	No	Filter start date (ISO 8601)
endDate	string	No	Filter end date (ISO 8601)

Try It Out

POST/api/bpm/cmdRetrieveDisbursementsQuery

Base URL

Bearer Token

Request Body

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

Response Structure

{
  "success": true,
  "data": {
    "items": [
      {
        "disbursementId": 5001,
        "batchId": 1024,
        "sourceAccount": "0012345678",
        "destinationAccount": "0098765432",
        "amount": 250000.00,
        "narration": "March salary - John Doe",
        "status": "Successful",
        "processedAt": "2026-03-08T14:30:00Z"
      },
      {
        "disbursementId": 5002,
        "batchId": 1024,
        "sourceAccount": "0012345678",
        "destinationAccount": "0056781234",
        "amount": 180000.00,
        "narration": "March salary - Jane Smith",
        "status": "Successful",
        "processedAt": "2026-03-08T14:30:05Z"
      }
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 2,
    "totalPages": 1
  },
  "message": "Disbursements retrieved successfully"
}

Related Operations

• Retrieve Disbursement Batches — List batches
• Retrieve Disbursement Batch by ID — Get batch details
• Retrieve Disbursement Batch Entries — List entries before processing