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.
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 | Mandate product code |
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 | No | Payer's address |
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": "Draft" },
{ "id": 5014, "accountNumber": "2098765432", "bankCode": "044", "status": "Draft" }
]
},
"responseCode": "00",
"responseDescription": "GSI mandates created successfully"
}
Related Operations​
- Create NIBSS Mandate — Create a standard single mandate
- Authorise NIBSS Mandate — Submit created mandates to NIBSS
- Retrieve NIBSS Mandates — List and search mandates