NIBSS Collections API

Overview

The NIBSS Collections API provides commands for creating, managing, and executing direct debit collection batches via NIBSS. Collections are organized into batches that follow a lifecycle from creation through activation and execution, enabling bulk debit processing against authorized mandates.

Collection Batch Lifecycle

Available Commands

#	Command	Description	Type
1	CreateNibssCollectionBatchCommand	Create an empty collection batch	Command
2	CreateNibssCollectionBatchWithItemsCommand	Create a batch pre-populated with collection items	Command
3	AddNibssCollectionToBatchCommand	Add a single collection item to a draft batch	Command
4	ActivateNibssCollectionBatchCommand	Activate a draft batch for execution	Command
5	DeactivateNibssCollectionBatchCommand	Return an active batch to draft status	Command
6	CancelNibssCollectionBatchCommand	Cancel a collection batch permanently	Command
7	RunNibssCollectionBatchCommand	Execute the batch — triggers NIBSS direct debits	Command
8	RetrieveNibssCollectionBatchesQuery	List and filter collection batches	Query
9	RetrieveNibssCollectionsQuery	List and filter individual collection items	Query
10	RetrieveNibssCollectionTransactionsQuery	List and filter collection transactions	Query

API Endpoint

All commands and queries are sent as a POST request to:

POST /api/bpm/cmd

The command name is sent alongside the payload, and the ApiPlayground component on each page handles this automatically.