RevKeenDocs
StatusSupport
API Reference
Mandates

List Direct Debit mandates

GET/mandates

Related endpoints

  • GET /mandates/{id} — Retrieve a Direct Debit mandate
  • 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.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

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

Query Parameters

customerId?string

Filter mandates by customer (UUID)

Formatuuid
status?string

Filter mandates by status

Value in

  • "pending_lodgement"
  • "active"
  • "suspended"
  • "cancelled"
  • "failed"

Response Body

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?customerId=11111111-1111-4111-8111-111111111111&status=pending_lodgement" \
  -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",      "notice_days": 10,      "activated_at": "2026-04-07T09:00:00.000Z",      "created_at": "2026-04-02T10:10:00.000Z"    }  ]}

Put this endpoint to work

Operate Direct Debit