Retrieve Disbursement Batch Entries

Overview

Retrieves a paginated list of entries within a disbursement batch. Each entry represents a single transfer to a destination account.

Command Details

• Command: RetrieveDisbursementBatchEntriesQuery
• 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)
batchId	long	No	Filter by batch ID
isExport	bool	No	Export mode (default: false)

Try It Out

POST/api/bpm/cmdRetrieveDisbursementBatchEntriesQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveDisbursementBatchEntriesQuery", "data": { "pageNumber": 1, "pageSize": 10, "batchId": 1024, "isExport": false } }

Response Structure

{
  "success": true,
  "data": {
    "items": [
      {
        "entryId": 3085,
        "batchId": 1024,
        "bankCode": "058",
        "destinationAccount": "0098765432",
        "amount": 250000.00,
        "narration": "March salary - John Doe",
        "status": "Pending"
      },
      {
        "entryId": 3086,
        "batchId": 1024,
        "bankCode": "044",
        "destinationAccount": "0056781234",
        "amount": 180000.00,
        "narration": "March salary - Jane Smith",
        "status": "Pending"
      }
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 2,
    "totalPages": 1
  },
  "message": "Entries retrieved successfully"
}

Related Operations

• Add Disbursement Batch Entry — Add an entry to the batch
• Remove Disbursement Batch Entry — Remove an entry from the batch
• Retrieve Disbursement Batch by ID — Get batch details