Update NIBSS Mandate

Overview

The UpdateNibssMandateCommand updates an existing NIBSS direct debit mandate. A grouped GSI mandate can only be updated while its batch is Building. Other mandates retain the existing Draft/Rejected edit rule. Once a grouped GSI batch is finalized, its mandates can no longer be edited.

Command Details

• Command: UpdateNibssMandateCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
mandateId	long	Yes	The ID of the mandate to update
amount	decimal	No	Updated total mandate amount
debitAmount	decimal	No	Updated debit instalment amount
numberOfInstallments	int	No	Updated number of instalments
mobileNumber	string	No	Updated mobile number
emailAddress	string	No	Updated email address
payerName	string	No	Updated payer name
tag	string	No	Updated tag

Try It Out

POST/api/bpm/cmdUpdateNibssMandateCommand

Base URL

Bearer Token

Request Body

{ "cmd": "UpdateNibssMandateCommand", "data": { "mandateId": 5012, "amount": 600000, "debitAmount": 60000, "mobileNumber": "08012345678", "emailAddress": "john.updated@example.com" } }

Response Structure

{
  "response": {
    "id": 5012,
    "status": "Draft"
  },
  "responseCode": "00",
  "responseDescription": "Mandate updated successfully"
}

Related Operations

• Create NIBSS Mandate — Create a new mandate
• Authorise NIBSS Mandate — Submit the mandate to NIBSS after updates
• Retrieve NIBSS Mandate by ID — View current mandate details