RevKeenDocs

List Direct Debit mandates


Related endpoints

  • POST /mandates — Create a Direct Debit mandate
  • 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

  • 401 unauthenticated — missing, malformed, or revoked API key.

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.

GET
/mandates
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

Query Parameters

customerId?string

Filter mandates by customer

status?string

Filter mandates by status (e.g. active, suspended, cancelled)

Response Body

application/json

curl "https://api.revkeen.com/v2/mandates" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "string",
      "mandate_ref": "string",
      "mandate_reference": "string",
      "customer_id": "string",
      "status": "string",
      "account_holder_name": "string",
      "sort_code": "string",
      "account_number_last4": "string",
      "bank_name": "string",
      "notice_days": 0,
      "activated_at": "string",
      "created_at": "string"
    }
  ]
}
Empty