Create NIBSS Collection Batch

Overview

Creates an empty collection batch in Draft status. Items can be added individually using the Add Item command before activating and running the batch.

Command Details

• Command: CreateNibssCollectionBatchCommand
• 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)

Try It Out

POST/api/bpm/cmdCreateNibssCollectionBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CreateNibssCollectionBatchCommand", "data": { "batchName": "March 2026 Loan Collections", "batchDescription": "Monthly loan repayment collection batch", "organisationId": 1001, "narration": "Monthly collection run", "collectionType": 0 } }

Response Structure

{
  "response": {
    "id": 2001,
    "status": "Draft"
  },
  "responseCode": "00",
  "responseDescription": "Batch created successfully"
}

Related Operations

• Create Batch with Items — Create a batch pre-populated with collection items
• Add Item to Batch — Add individual collection items to this batch
• Activate Batch — Activate the batch for execution