Add Item to NIBSS Collection Batch

Overview

Adds a single collection item to an existing batch. The batch must be in Draft status to accept new items.

Command Details

• Command: AddNibssCollectionToBatchCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchId	long	Yes	ID of the collection batch to add to
mandateId	long	Yes	ID of the NIBSS mandate to collect against
amount	decimal	Yes	Amount to collect
narration	string	No	Narration for this collection item
collectionDate	string	No	Scheduled collection date (ISO 8601)

Try It Out

POST/api/bpm/cmdAddNibssCollectionToBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "AddNibssCollectionToBatchCommand", "data": { "batchId": 2001, "mandateId": 5014, "amount": 45000, "narration": "Loan repayment - David Obi", "collectionDate": "2026-03-15" } }

Response Structure

{
  "response": {
    "id": 30045
  },
  "responseCode": "00",
  "responseDescription": "Collection item added to batch"
}

Related Operations

• Create Batch — Create a new empty batch first
• Create Batch with Items — Create a batch with items in one call
• Activate Batch — Activate the batch once all items are added