Schedule mandate termination
POST/api/v1/mandates/:id/terminate
Schedules the termination of an active mandate by setting an end_date (minimum tomorrow). The mandate remains active until a daily sweep job terminates it on or after the scheduled date.
Request
Responses
- 200
- 401
- 403
- 404
- 422
Termination was scheduled: the mandate remains active with end_date set. A daily background job terminates it once end_date is reached.
Missing, invalid, or expired OAuth 2.0 bearer token.
The OAuth access token does not include the scope required for this operation.
No mandate with this ID exists, or it belongs to a tenant the authenticated OAuth application cannot access.
The request failed validation: end_date must be tomorrow or later in a valid date format, or the mandate is not active. Omitting end_date on an active mandate with a scheduled termination cancels that termination instead of returning an error.