Skip to main content

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​

FieldTypeRequiredDescription
narrationstringNoDescription for the batch
productCodestringYesProduct code applied to all mandates
branchCodestringYesOriginating branch code
organisationCodestringYesOrganisation code
mandatesarrayYesArray of mandate objects

Each item in mandates:

FieldTypeRequiredDescription
clientCodestringYesClient identifier code
amountdecimalYesTotal mandate amount
debitAmountdecimalYesAmount per debit instalment
numberOfInstallmentsintNoNumber of instalments
startDateDateTimeYesMandate start date
endDateDateTimeYesMandate end date
mobileNumberstringYesPayer's mobile number
emailAddressstringYesPayer's email address
payerNamestringYesFull name of the payer
payerAddressstringNoPayer's address
accountNumberstringYesPayer's account number
bvnstringYesPayer's Bank Verification Number
bankCodestringYesCBN bank code of the payer's bank
accountNamestringYesPayer's account name
tagstringNoOptional tag for categorisation

Try It Out​

POST/api/bpm/cmdCreateNibssMandateListCommand
Request Body

Response Structure​

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