Cancel a Direct Debit mandate
Cancels a mandate. If it was lodged with the bureau, the London & Zurich customer is cancelled too.
Related endpoints
POST /mandates— Create a Direct Debit mandateGET /mandates— List Direct Debit mandatesGET /mandates/{id}— Retrieve a Direct Debit mandatePOST /mandates/{id}/suspend— Suspend a Direct Debit mandatePOST /mandates/{id}/reinstate— Reinstate a suspended Direct Debit mandatePOST /mandates/{id}/collections— Schedule a one-off Direct Debit collection
Common errors
400 invalid_request— malformed payload or failed validation.401 unauthenticated— missing, malformed, or revoked API key.404 resource_missing— the referenced resource does not exist or is not visible to your key.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
Authorization
apiKey x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Path Parameters
id*string
Mandate ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
reason?string
Optional reason recorded on the audit trail
Response Body
application/json
curl -X POST "https://api.revkeen.com/v2/mandates/string/cancel" \ -H "x-api-key: $REVKEEN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "reason": "customer_request" }'{
"data": {
"id": "string",
"status": "cancelled",
"mandate_reference": "string"
}
}Empty
Empty
Empty