RevKeenDocs
StatusSupport
API Reference
Mandates

Retrieve a Direct Debit mandate

GET/mandates/{id}

Related endpoints

  • GET /mandates — List Direct Debit mandates
  • POST /mandates/{id}/cancel — Cancel a Direct Debit mandate
  • POST /mandates/{id}/suspend — Suspend 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.

Authorization

apiKey mandates:read
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

Scope: mandates:read

Path Parameters

id*string

Mandate UUID

Formatuuid

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 GET "https://api.revkeen.com/v2/mandates/11111111-1111-4111-8111-111111111111" \
  -H "x-api-key: $REVKEEN_API_KEY"

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

{  "data": {    "id": "6a7b8c9d-0e1f-4a32-8c3d-4e5f6a7b8c31",    "mandate_ref": "RKEXAM01",    "mandate_reference": "RKEXAM01",    "customer_id": "c2a1e7d4-5b3f-4a8e-9d21-6f0b3e4c7a11",    "status": "active",    "account_holder_name": "Ada Lovelace",    "sort_code": "XX-XX-**",    "account_number_last4": "0000",    "bank_name": "Example Bank",    "statement_name": "REVKEEN PRO",    "notice_days": 10,    "first_collection_date": "2026-05-18",    "next_collection_date": "2026-05-18",    "backup_payment_method_id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c65",    "activated_at": "2026-04-07T09:00:00.000Z",    "suspended_at": null,    "cancelled_at": null,    "failure_reason": null,    "created_at": "2026-04-02T10:10:00.000Z",    "updated_at": "2026-04-07T09:00:00.000Z"  }}

Put this endpoint to work

Operate Direct Debit