mutex core apisdocs

Suspend a mandate

Pause an active DebiPay mandate for a defined period using the suspend operation.

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

Body

mandateIdstringrequired
Length: >= 0, <= 36
suspensionReasonnull | string
suspensionDurationInMonthsinteger | string<int32>
Pattern: ^-?(?:0|[1-9]\d*)$

Use this endpoint to temporarily suspend a mandate instead of cancelling it outright. The request body supports the mandate identifier, an optional suspension reason, and a duration in months.

Choose the suspend operation when you need a temporary pause rather than a permanent removal of the mandate.

When to use it

  • Pause a mandate during a temporary customer issue.
  • Stop processing for a defined period while preserving the mandate record.
  • Prepare for a later reactivation without recreating the mandate.

Request details

The request body includes the mandateId and may include suspensionReason and suspensionDurationInMonths. Review the generated request schema for the full accepted fields.

Response handling

The API returns a confirmation that the suspension request was accepted. Use the generated response model to inspect the resulting status and any supplemental details returned by your deployment.

If the pause should be permanent, use the cancel endpoint instead of suspend.

Related pages