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​
| Field | Type | Required | Description |
|---|---|---|---|
narration | string | No | Description for the mandate |
productCode | string | Yes | Loan product code from loanProductConfiguration |
branchCode | string | Yes | Originating branch code |
organisationCode | string | Yes | Organisation code |
clientCode | string | Yes | Client identifier code |
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. |
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 |
tag | string | No | Optional tag for categorisation |
accounts | array | Yes | Bank accounts to attach to the mandate |
Each item in accounts:
| Field | Type | Required | Description |
|---|---|---|---|
accountNumber | string | Yes | Account number |
bvn | string | Yes | Bank Verification Number |
bankCode | string | Yes | CBN bank code |
accountName | string | Yes | Account holder name |
Try It Out​
POST
/api/bpm/cmdCreateNibssGSIMandateCommandRequest 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"
}
Related Operations​
- Create NIBSS Mandate — Create a standard single mandate
- Manage a NIBSS GSI Batch — Add accounts and finalize the batch
- Retrieve NIBSS Mandates — List and search mandates