Create NIBSS Mandate List

Overview

The CreateNibssMandateListCommand creates multiple NIBSS direct debit mandates in a single batch operation. All mandates are created in Draft status.

Command Details

• Command: CreateNibssMandateListCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
narration	string	No	Description for the batch
productCode	string	Yes	Loan product code from loanProductConfiguration, applied to all mandates
branchCode	string	Yes	Originating branch code
organisationCode	string	Yes	Organisation code
mandates	array	Yes	Array of mandate objects

Each item in mandates:

Field	Type	Required	Description
clientCode	string	Yes	Client identifier code
amount	decimal	Yes	Total mandate amount
debitAmount	decimal	Yes	Amount per debit instalment
numberOfInstallments	int	No	Number of instalments
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. A blank or non-address value is rejected before the batch is inserted.
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
tag	string	No	Optional tag for categorisation

Try It Out

Each mandate receives a generated NIBSS subscriberCode between 10 and 20 characters. clientCode remains the application's client identifier and is not sent as the NIBSS subscriber code.

POST/api/bpm/cmdCreateNibssMandateListCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CreateNibssMandateListCommand", "data": { "narration": "Bulk mandate creation - Q2 2026", "productCode": "PROD-LN-001", "branchCode": "BR-001", "organisationCode": "ORG-001", "mandates": [ { "clientCode": "CLT-001", "amount": 500000, "debitAmount": 50000, "numberOfInstallments": 12, "startDate": "2026-04-01", "endDate": "2027-03-31", "mobileNumber": "08012345678", "emailAddress": "john@example.com", "payerName": "John Doe", "payerAddress": "15 Marina Street, Lagos", "accountNumber": "0012345678", "bvn": "22345678901", "bankCode": "058", "accountName": "John Doe" }, { "clientCode": "CLT-002", "amount": 300000, "debitAmount": 30000, "numberOfInstallments": 10, "startDate": "2026-04-01", "endDate": "2027-01-31", "mobileNumber": "08098765432", "emailAddress": "jane@example.com", "payerName": "Jane Smith", "payerAddress": "20 Broad Street, Lagos", "accountNumber": "0098765432", "bvn": "33456789012", "bankCode": "044", "accountName": "Jane Smith" } ] } }

Response Structure

{
  "response": {
    "batchId": 301,
    "count": 2
  },
  "responseCode": "00",
  "responseDescription": "Mandates created successfully"
}

Related Operations

• Create NIBSS Mandate — Create a single mandate
• Retrieve NIBSS Mandate Batches — List mandate batches
• Authorise NIBSS Mandate — Submit mandates to NIBSS