RevKeenDocs

List the authenticated customer's Direct Debit mandates

Returns the customer's Direct Debit mandates (status, masked account, next collection date). Requires the merchant to have portal DD self-service enabled.


Related endpoints

  • POST /customer-portal/sessions — Create a customer-portal session
  • GET /customer-portal/customer — Retrieve the authenticated customer
  • GET /customer-portal/subscriptions — List the authenticated customer's subscriptions
  • GET /customer-portal/subscriptions/{id} — Retrieve a subscription
  • POST /customer-portal/subscriptions/{id}/cancel — Cancel a subscription
  • GET /customer-portal/invoices — List the authenticated customer's invoices
  • GET /customer-portal/invoices/{id} — Retrieve an invoice
  • POST /customer-portal/mandates/{id}/re-authorize — Re-authorise a Direct Debit mandate with new bank details

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 403 permission_denied — key lacks the required scope, or the resource belongs to a different merchant.

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
/customer-portal/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

Response Body

application/json

application/json

application/json

curl "https://api.revkeen.com/v2/customer-portal/mandates" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "object": "mandate",
      "status": "string",
      "account_holder_name": "string",
      "account_number_last4": "string",
      "bank_name": "string",
      "mandate_reference": "string",
      "next_collection_date": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true,
  "url": "string"
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}