Cancel NIBSS Collection Batch

Overview

Cancels a collection batch permanently. Cancelled batches cannot be reactivated or executed. Use this when a batch is no longer needed.

Command Details

• Command: CancelNibssCollectionBatchCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchId	long	Yes	ID of the collection batch to cancel

Try It Out

POST/api/bpm/cmdCancelNibssCollectionBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CancelNibssCollectionBatchCommand", "data": { "batchId": 2001 } }

Response Structure

{
  "response": {
    "id": 2001,
    "status": "Cancelled"
  },
  "responseCode": "00",
  "responseDescription": "Batch cancelled successfully"
}

Related Operations

• Retrieve Batches — View all batches including cancelled ones
• Create Batch — Create a new batch to replace the cancelled one