RevKeenDocs
StatusSupport
API Reference
Mandates

List Direct Debit mandates

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

Query Parameters

customerId?string

Filter mandates by customer

status?string

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

Response Body

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=cus_1RxKm3ApBqCrDsEtFuGvHwJx&status=example" \
  -H "x-api-key: $REVKEEN_API_KEY"

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

{  "data": [    {      "id": "00000000-0000-4000-8000-000000000001",      "mandate_ref": "string",      "mandate_reference": "string",      "customer_id": "00000000-0000-4000-8000-000000000001",      "status": "string",      "account_holder_name": "string",      "sort_code": "string",      "account_number_last4": "string",      "bank_name": "string",      "notice_days": 0,      "activated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Put this endpoint to work

Operate Direct Debit