Cancel a mandate (via Sponser Bank)
Cancels an active mandate. Supply the unique LotusPay mandate identifier or the UMRN. The mandate's status should be active, and its cancel_status should be cancel_nil. To cancel an external mandate, first you must import it. Mandates can be cancelled with the mandate sponsor bank only.
In this flow, user cancels the mandate at the merchants end. Merchants calls cancel mandate API, and based on the cut off time the cancel mandate file is submitted to sponsor bank and would take about 2-3 days for mandate cancellation. All Destination banks are live on this flow.
ARGUMENTS
|
Argument
|
Description
|
|---|---|
id optional
| The identifier of the mandate to be cancelled. Either id or umrn must be supplied.
|
umrn/{umrn} optional
| The NACH Unique Mandate Reference Number of the mandate to be cancelled. Relative endpoint is: v1/mandates/umrn/{umrn}/cancel. Either id or umrn must be supplied.
|
Returns Returns a cancelled mandate if a valid identifier was provided. Thestatus will remain active but the cancel_status will change to cancel_requested. If the mandate status is not active, or if the mandate's status is active but its cancel_status is cancel_requested or cancel_submitted, returns invalid state error.
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
