Cancel NPS Mandate

Overview

CancelNpsMandateCommand cancels an active outward NPS mandate by sending a pain.011 cancellation request via the BankLingo Nibss API. On success, the local MandateSetup record is updated to Cancelled.

Outward mandates only

Only mandates we originated (destinationInstitutionCode ≠ our bank code) can be cancelled. Inward mandates (where we are the debtor bank) must be rejected or stopped through the NPS network flow.

Command Details

• Command: CancelNpsMandateCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
mandateReferenceNumber	string	Yes	NPS mandate reference number to cancel
reason	string	No	Cancellation reason (default: "Cancelled by administrator")

Try It Out

POST/api/bpm/cmdCancelNpsMandateCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CancelNpsMandateCommand", "data": { "mandateReferenceNumber": "MND0000000001", "reason": "Customer requested cancellation" } }

Response Structure

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "NPS mandate cancellation submitted successfully.",
  "data": {
    "id": 101,
    "mandateReferenceNumber": "MND0000000001",
    "mandateStatus": "Cancelled",
    "lastUpdated": "2026-07-05T09:00:00Z",
    "nibssApiResponse": "{\"responseCode\":\"00\",\"responseDescription\":\"Successful\"}"
  }
}

Error Responses

Condition	Message
Mandate not found	"NPS mandate 'MND...' not found."
Already cancelled	"Mandate is already cancelled."
Nibss API rejected	"Nibss API rejected (HTTP 400)." with nibssApiResponse detail

Related Operations

• Get NPS Mandate by ID — Verify mandate status before cancelling
• Amend NPS Mandate — Modify mandate instead of cancelling