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)
startDate	string	No	Inclusive CreatedDate filter start date (ISO 8601)
endDate	string	No	Inclusive CreatedDate filter end date (ISO 8601)
filters	array	No	Dynamic field filters using field, operator, and value
searchText	string	No	Text to search for in the supplied searchFields
searchFields	string[]	No	Entry string fields searched by searchText

Try It Out

POST/api/bpm/cmdRetrieveDisbursementBatchEntriesQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveDisbursementBatchEntriesQuery", "data": { "pageNumber": 1, "pageSize": 10, "batchId": 1024, "isExport": false, "startDate": "2026-01-01", "endDate": "2026-01-31", "searchText": "Guaranty", "searchFields": [ "DestinationBank", "RecipientName" ] } }

Response Structure

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "Disbursement batch entries retrieved.",
  "data": [
    {
      "id": 3085,
      "disbursementBatchId": 1024,
      "batchReference": "DB-202601-0001",
      "transactionReference": "TXN-0003085",
      "sourceAccount": "0012345678",
      "destinationAccount": "0098765432",
      "destinationBankCode": "058",
      "destinationBank": "GUARANTY TRUST BANK",
      "recipientName": "John Doe",
      "senderName": "Example Company",
      "amount": 250000.00,
      "fees": 50.00,
      "comment": "March salary - John Doe",
      "disbursmentStatus": 1,
      "disbursmentStatusDesc": "Pending Account Validation",
      "resposeMessage": null,
      "sessionId": null,
      "reviewerComment": "Approved after confirming the customer's documentation.",
      "reviewerApprovedOrRejectedDate": "2026-01-15T10:31:00Z",
      "createdDate": "2026-01-15T10:30:00Z",
      "lastUpdated": "2026-01-15T10:30:00Z",
      "transactionSource": 1
    }
  ],
  "count": 1,
  "pages": 1,
  "size": 10,
  "hasNext": false,
  "hasPrevious": false
}

destinationBank is the resolved bank name stored when the batch entry is created.

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