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.
/customer-portal/mandatesReturns 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 sessionGET /customer-portal/customer— Retrieve the authenticated customerGET /customer-portal/subscriptions— List the authenticated customer's subscriptionsGET /customer-portal/subscriptions/{id}— Retrieve a subscriptionPOST /customer-portal/subscriptions/{id}/cancel— Cancel a subscriptionGET /customer-portal/invoices— List the authenticated customer's invoicesGET /customer-portal/invoices/{id}— Retrieve an invoicePOST /customer-portal/mandates/{id}/re-authorize— Re-authorise a Direct Debit mandate with new bank details
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 aWWW-Authenticate: Bearerchallenge.403 authorization_error— the caller is identified but the action is denied. Codes includeinsufficient_permissions,ip_not_allowed,merchant_mismatch, andorigin_not_allowed.
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.
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
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.revkeen.com/v2/customer-portal/mandates" \
-H "Authorization: Bearer $REVKEEN_PORTAL_TOKEN"Synthetic documentation data, validated against the response schema; not a live API result.
{ "object": "list", "data": [ { "id": "00000000-0000-4000-8000-000000000001", "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": "https://example.com/webhooks/revkeen"}