Cancel a Direct Debit mandate
Cancels the mandate for future collections only. Requires portal DD self-service. Bank changes affect future only (per approved V13 mockup).
/customer-portal/mandates/{id}/cancelCancels the mandate for future collections only. Requires portal DD self-service. Bank changes affect future only (per approved V13 mockup).
Related endpoints
POST /customer-portal/sessions— Create a customer-portal sessionGET /customer-portal/customer— Retrieve the authenticated customerGET /customer-portal/subscriptions— List the authenticated customer's subscriptionsGET /customer-portal/subscriptions/{id}— Retrieve a subscriptionPOST /customer-portal/subscriptions/{id}/cancel— Cancel a subscriptionGET /customer-portal/invoices— List the authenticated customer's invoicesGET /customer-portal/invoices/{id}— Retrieve an invoiceGET /customer-portal/mandates— List the authenticated customer's Direct Debit mandates
Common errors
400 invalid_request— malformed payload or failed validation.403 authorization_error— the caller is identified but the action is denied. Codes includeinsufficient_permissions,ip_not_allowed,merchant_mismatch, andorigin_not_allowed.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.
Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.
In: header
Path Parameters
Mandate ID
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.revkeen.com/v2/customer-portal/mandates/11111111-1111-4111-8111-111111111111/cancel" \
-H "Authorization: Bearer $REVKEEN_PORTAL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"reason": "example"
}'Synthetic documentation data, validated against the response schema; not a live API result.
{ "data": { "id": "6a7b8c9d-0e1f-4a32-8c3d-4e5f6a7b8c31", "object": "mandate", "status": "active", "account_holder_name": "Ada Lovelace", "account_number_last4": "0000", "bank_name": "Example Bank", "mandate_reference": "RKEXAM01", "next_collection_date": "2026-05-18", "created_at": "2026-04-02T10:10:00.000Z" }}