Skip to main content

Cancel Remita Collection Batch

Overview​

Cancels a collection batch, permanently preventing it from being run. Once cancelled, a batch cannot be reactivated or authorized.

Command Details​

  • Command: CancelRemitaCollectionBatchCommand
  • Type: Command

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
idlongYesThe ID of the batch to cancel

Try It Out​

POST/api/bpm/cmdCancelRemitaCollectionBatchCommand
Request Body

Response Structure​

{
"success": true,
"data": {
"id": 3001,
"status": "Cancelled",
"cancelledAt": "2026-03-08T13:00:00Z"
},
"message": "Collection batch cancelled successfully"
}