Skip to main content

Create NIBSS GSI Mandate

Overview​

The CreateNibssGSIMandateCommand creates a GSI (Growing Single Instruction) mandate via NIBSS. GSI mandates enable collections across multiple bank accounts linked to the borrower, ensuring recovery even if the primary account has insufficient funds.

Every mandate entry starts in Building (-1). Add all required same-BVN accounts, then call FinalizeNibssGSIMandateBatchCommand to move the batch to Draft (0, Ready for Submission). The background job does not select Building entries.

Command Details​

  • Command: CreateNibssGSIMandateCommand
  • Type: Command

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
narrationstringNoDescription for the mandate
productCodestringYesLoan product code from loanProductConfiguration
branchCodestringYesOriginating branch code
organisationCodestringYesOrganisation code
clientCodestringYesClient identifier code
payerNamestringYesFull name of the payer
payerAddressstringYesPayer's address. A blank or non-address value is rejected before the batch is inserted.
amountdecimalYesTotal mandate amount
debitAmountdecimalYesAmount per debit instalment
numberOfInstallmentsintNoNumber of instalments (default: 1)
startDateDateTimeYesMandate start date
endDateDateTimeYesMandate end date
mobileNumberstringYesPayer's mobile number
emailAddressstringYesPayer's email address
tagstringNoOptional tag for categorisation
accountsarrayYesBank accounts to attach to the mandate

Each item in accounts:

FieldTypeRequiredDescription
accountNumberstringYesAccount number
bvnstringYesBank Verification Number
bankCodestringYesCBN bank code
accountNamestringYesAccount holder name

Try It Out​

POST/api/bpm/cmdCreateNibssGSIMandateCommand
Request Body

Response Structure​

{
"response": {
"mandates": [
{ "id": 5013, "accountNumber": "0012345678", "bankCode": "058", "status": "Building" },
{ "id": 5014, "accountNumber": "2098765432", "bankCode": "044", "status": "Building" }
]
},
"responseCode": "00",
"responseDescription": "GSI mandates created successfully"
}