Stop NIBSS Mandate
Overview​
The StopNibssMandateCommand stops an active mandate, preventing further collections from being made against the payer's account.
Command Details​
- Command:
StopNibssMandateCommand - Type: Command
API Endpoint​
POST /api/bpm/cmd
Request Structure​
| Field | Type | Required | Description |
|---|---|---|---|
mandateId | long | Yes | The ID of the mandate to stop |
reason | string | No | Reason for stopping the mandate |
Try It Out​
POST
/api/bpm/cmdStopNibssMandateCommandRequest Body
Response Structure​
{
"response": {
"id": 5012,
"status": "Stopped"
},
"responseCode": "00",
"responseDescription": "Mandate stopped successfully"
}
Related Operations​
- Start NIBSS Mandate — Start a mandate for collections
- Refresh NIBSS Mandate Status — Sync status from NIBSS
- Retrieve NIBSS Mandate by ID — Check mandate status