Create NIBSS Collection Batch with Items

Overview

Creates a collection batch and populates it with collection items in a single call. This is ideal when all collection items are known upfront, avoiding the need to create a batch and add items separately.

Command Details

• Command: CreateNibssCollectionBatchWithItemsCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchName	string	Yes	Human-readable name for the collection batch
batchDescription	string	No	Additional description for the batch
organisationId	long	Yes	ID of the organisation owning this batch
narration	string	No	Narration shown on debit transactions
collectionType	int	No	Collection type identifier (default: 0)
collections	array	Yes	List of collection items to include
collections[].mandateId	long	Yes	ID of the NIBSS mandate to collect against
collections[].amount	decimal	Yes	Amount to collect
collections[].narration	string	No	Per-item narration
collections[].collectionDate	string	No	Scheduled collection date (ISO 8601)

Try It Out

POST/api/bpm/cmdCreateNibssCollectionBatchWithItemsCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CreateNibssCollectionBatchWithItemsCommand", "data": { "batchName": "March 2026 Loan Collections", "batchDescription": "Monthly loan repayment batch with items", "organisationId": 1001, "narration": "Monthly collection run", "collectionType": 0, "collections": [ { "mandateId": 5012, "amount": 50000, "narration": "Loan repayment - John Doe", "collectionDate": "2026-03-15" }, { "mandateId": 5013, "amount": 30000, "narration": "Loan repayment - Jane Smith", "collectionDate": "2026-03-15" } ] } }

Response Structure

{
  "response": {
    "id": 2002,
    "status": "Draft",
    "itemCount": 2
  },
  "responseCode": "00",
  "responseDescription": "Batch created with 2 items"
}

Related Operations

• Create Batch — Create an empty batch and add items separately
• Add Item to Batch — Add more items to the batch after creation
• Activate Batch — Activate the batch for execution