NIBSS Mandates API

Overview

The NIBSS Mandates API provides commands for creating, managing, and querying NIBSS direct debit mandates. Mandates authorize recurring debits against a payer's bank account and follow a defined lifecycle from creation through activation and eventual stoppage.

All commands are sent via POST /api/bpm/cmd with a JSON body containing cmd (command name) and data (payload).

Mandate Lifecycle

Available Commands

#	Command	Description	Type
1	CreateNibssMandateCommand	Create a single NIBSS direct debit mandate	Command
2	CreateNibssMandateListCommand	Create multiple mandates in a batch	Command
3	CreateNibssGSIMandateCommand	Create a GSI mandate across multiple accounts	Command
4	UpdateNibssMandateCommand	Update a mandate in Draft status	Command
5	AuthoriseNibssMandateCommand	Submit a mandate to NIBSS for approval	Command
6	DisapproveNibssMandateCommand	Reject a mandate	Command
7	StartNibssMandateCommand	Activate a mandate for collections	Command
8	StopNibssMandateCommand	Stop an active mandate	Command
9	RefreshNibssMandateStatusCommand	Sync mandate status from NIBSS	Command
10	RetrieveNibssMandateBatchesQuery	List mandate batches with pagination	Query
11	RetrieveNibssMandatesQuery	Search and list mandates	Query
12	RetrieveNibssMandateByIdQuery	Get a single mandate by ID	Query
13	RetrieveNibssMandateProductsQuery	List configured mandate products	Query