mutex core apisdocs

Cancel an active mandate

Stop an existing mandate by sending a cancellation request to the DebiPay mandates API.

PUThttps://api.debipay.co.za/api/v1/mandates/cancel
Loading code example

Body

mandateIdstringrequired
cancellationReasonnull | string

Use this endpoint when you need to terminate an active mandate before it continues to collect funds. The request body uses the DebiPay cancel command model and allows you to include the mandate identifier and an optional reason for the cancellation.

This is the appropriate operation when a mandate should be ended because the customer has withdrawn consent, the relationship has changed, or the mandate is no longer needed.

What this endpoint is for

  • End a mandate that is no longer valid.
  • Record a reason for the termination.
  • Keep your mandate lifecycle aligned with customer or merchant changes.

Request details

The body includes the mandateId value and may optionally include a cancellationReason. Review the generated request schema in the right panel for the exact shape accepted by your deployment.

Response handling

The API returns a confirmation that the cancellation request was accepted. Use the generated response schema to confirm the status values and any additional details returned by your instance.

If you need a temporary pause instead of a full termination, use the suspend endpoint rather than cancellation.

Related pages