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 | Product code 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 | No | Payer's address |
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​
POST
/api/bpm/cmdCreateNibssMandateListCommandRequest Body
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