Retrieve Disbursement Batches

Overview

Retrieves a paginated list of disbursement batches. Supports filtering by date range to help locate specific batches.

Command Details

• Command: RetrieveDisbursementBatchesQuery
• 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/cmdRetrieveDisbursementBatchesQuery

Base URL

Bearer Token

Request Body

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

Response Structure

{
  "success": true,
  "data": {
    "items": [
      {
        "batchId": 1024,
        "sourceAccount": "0012345678",
        "batchDescription": "March 2026 Salary Disbursement",
        "status": "PendingReview",
        "totalAmount": 430000.00,
        "entryCount": 2,
        "createdBy": "admin@bank.com",
        "createdAt": "2026-03-08T10:30:00Z"
      }
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1
  },
  "message": "Batches retrieved successfully"
}

Related Operations

• Retrieve Disbursement Batch by ID — Get details of a specific batch
• Retrieve Disbursement Batch Entries — List entries within a batch
• Initiate Disbursement Batch — Create a new batch