Cancel Disbursement Batch

Overview

Cancels a disbursement batch. A batch can be cancelled at any point before it begins processing. Once cancelled, the batch cannot be reactivated and no disbursements will be made.

Command Details

• Command: CancelDisbursementBatchCommand
• Type: Command (write operation)
• Batch status requirement: Draft, PendingReview, Reviewed, or Rejected
• Status on success: Cancelled
• Permissions required: Disbursement Create

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchId	long	Yes	ID of the batch
comment	string	No	Cancellation reason

Try It Out

POST/api/bpm/cmdCancelDisbursementBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CancelDisbursementBatchCommand", "data": { "batchId": 1024, "comment": "Batch no longer needed" } }

Response Structure

{
  "success": true,
  "data": {
    "batchId": 1024,
    "status": "Cancelled",
    "cancelledBy": "admin@bank.com",
    "cancelledAt": "2026-03-08T15:00:00Z",
    "comment": "Batch no longer needed"
  },
  "message": "Batch cancelled successfully"
}

Related Operations

• Delete Disbursement Batch — Permanently delete a batch
• Retrieve Disbursement Batch by ID — Check batch status
• Retrieve Disbursement Batches — List all batches