Retrieve Disbursement Batch by ID

Overview

Retrieves the full details of a single disbursement batch by its ID, including status, metadata, and summary information.

Command Details

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

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchId	long	Yes	ID of the batch

Try It Out

POST/api/bpm/cmdRetrieveDisbursementBatchByIdQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveDisbursementBatchByIdQuery", "data": { "batchId": 1024 } }

Response Structure

{
  "success": true,
  "data": {
    "batchId": 1024,
    "sourceAccount": "0012345678",
    "batchDescription": "March 2026 Salary Disbursement",
    "status": "Approved",
    "totalAmount": 430000.00,
    "entryCount": 2,
    "createdBy": "admin@bank.com",
    "createdAt": "2026-03-08T10:30:00Z",
    "confirmedAt": "2026-03-08T11:00:00Z",
    "reviewedBy": "jane.reviewer@bank.com",
    "reviewedAt": "2026-03-08T12:00:00Z",
    "approvedBy": "john.approver@bank.com",
    "approvedAt": "2026-03-08T14:00:00Z"
  },
  "message": "Batch retrieved successfully"
}

Related Operations

• Retrieve Disbursement Batches — List all batches
• Retrieve Disbursement Batch Entries — List entries within this batch
• Retrieve Disbursements — View processed disbursement records