RevKeenDocs
StatusSupport
API Reference
Mandates

Suspend a Direct Debit mandate

Suspends an active (or pending-lodgement) mandate.

POST/mandates/{id}/suspend

Suspends an active (or pending-lodgement) mandate.

Related endpoints

  • POST /mandates — Create a Direct Debit mandate
  • GET /mandates — List Direct Debit mandates
  • GET /mandates/{id} — Retrieve a Direct Debit mandate
  • POST /mandates/{id}/cancel — Cancel a Direct Debit mandate
  • POST /mandates/{id}/reinstate — Reinstate a suspended Direct Debit mandate
  • POST /mandates/{id}/collections — Schedule a one-off Direct Debit collection

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 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 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

id*string

Mandate ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Optional parameters for a mandate lifecycle action (cancel / suspend / reinstate).

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/mandates/rk_example_id/suspend" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "customer_request"
  }'

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "00000000-0000-4000-8000-000000000001",    "status": "cancelled",    "mandate_reference": "string"  }}

Put this endpoint to work

Operate Direct Debit