Create NIBSS Mandate

Overview

The CreateNibssMandateCommand creates a single NIBSS direct debit mandate. When mandateType is GSI, the command creates a grouped GSI batch containing one Building mandate and does not call NIBSS inline. More accounts can be added before the batch is finalized.

Command Details

• Command: CreateNibssMandateCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
narration	string	No	Description or narration for the mandate
loanQuoteId	long	No	Optional loan quote reference. When supplied for GSI, loan and product details are resolved through the loan-linked GSI flow.
mandate	object	Yes	Mandate details (see nested fields below)

Nested mandate fields:

Field	Type	Required	Description
clientCode	string	Yes	Client identifier code
productCode	string	Yes	Loan product code from loanProductConfiguration
amount	decimal	Yes	Total mandate amount
debitAmount	decimal	Yes	Amount per debit instalment
numberOfInstallments	int	No	Number of instalments (default: 1)
startDate	DateTime	Yes	Mandate start date
endDate	DateTime	Yes	Mandate end date
mobileNumber	string	Yes	Payer's mobile number
emailAddress	string	Yes	Payer's email address
payerName	string	Yes	Full name of the payer
payerAddress	string	Yes	Payer's address
branchCode	string	Yes	Originating branch code
organisationCode	string	Yes	Organisation code
mandateType	int	Yes	1 = Electronic, 2 = GSI, 3 = Paper Mandate
mandateFileBase64	string	If PaperMandate	Base64-encoded mandate file
mandateFileExtension	string	If PaperMandate	File extension (e.g., pdf, jpg)
tag	string	No	Optional tag for categorisation
accountNumber	string	Yes	Payer's account number
bvn	string	Yes	Payer's Bank Verification Number
bankCode	string	Yes	CBN bank code of the payer's bank
accountName	string	Yes	Payer's account name

Try It Out

POST/api/bpm/cmdCreateNibssMandateCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CreateNibssMandateCommand", "data": { "narration": "Monthly loan repayment mandate", "mandate": { "clientCode": "CLT-001", "productCode": "PROD-LN-001", "amount": 500000, "debitAmount": 50000, "numberOfInstallments": 12, "startDate": "2026-04-01", "endDate": "2027-03-31", "mobileNumber": "08012345678", "emailAddress": "customer@example.com", "payerName": "John Doe", "payerAddress": "15 Marina Street, Lagos", "branchCode": "BR-001", "organisationCode": "ORG-001", "mandateType": 1, "tag": "loan-repayment", "accountNumber": "0012345678", "bvn": "22345678901", "bankCode": "058", "accountName": "John Doe" } } }

Response Structure

{
  "response": {
    "id": 5012,
    "status": "Building"
  },
  "responseCode": "00",
  "responseDescription": "Mandate created successfully"
}

Related Operations

• Create NIBSS Mandate List — Create multiple mandates in a batch
• Manage a NIBSS GSI Batch — Add accounts and finalize a grouped GSI batch
• Authorise NIBSS Mandate — Submit the created mandate to NIBSS
• Update NIBSS Mandate — Modify the mandate before authorisation