Skip to main content

Run NIBSS Collection Batch

Overview​

Executes an Active collection batch, triggering NIBSS direct debit calls for each item in the batch. Each collection item is submitted to NIBSS for processing against the linked mandate.

warning

This triggers actual debit transactions against customer accounts via NIBSS. Ensure the batch is reviewed before running.

Command Details​

  • Command: RunNibssCollectionBatchCommand
  • Type: Command

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
batchIdlongYesID of the active collection batch to execute

Try It Out​

POST/api/bpm/cmdRunNibssCollectionBatchCommand
Request Body

Response Structure​

{
  "response": {
    "id": 2001,
    "status": "Processing",
    "processedCount": 3,
    "successCount": 2,
    "failedCount": 1
  },
  "responseCode": "00",
  "responseDescription": "Batch execution started"
}