Schedule a one-off Direct Debit collection

Schedules a one-off Bacs collection against an active mandate for an invoice or payment link. L&Z confirms the permitted collection date, the payer receives the configured regulatory advance notice first, and nothing is marked paid until the bureau confirms collection. Idempotent per source: retrying with the same sourceId returns or reconciles the same provider schedule instead of collecting twice.

---

Related endpoints

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

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.
• 403 authorization_error — the caller is identified but the action is denied. Codes include insufficient_permissions, ip_not_allowed, merchant_mismatch, and origin_not_allowed.
• 404 resource_missing — the referenced resource does not exist or is not visible to your key.
• 409 conflict — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
• 422 unprocessable_entity — business-rule failure (for example, refunding more than the original charge).

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Path Parameters

Response Body

curl -X POST "https://api.revkeen.com/v2/mandates/rk_example_id/collections" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amountMinor": 2500,
    "currency": "GBP",
    "sourceType": "invoice",
    "sourceId": "11111111-1111-4111-8111-111111111111"
  }'

{  "data": {    "id": "string",    "mandate_id": "00000000-0000-4000-8000-000000000001",    "lz_schedule_id": "00000000-0000-4000-8000-000000000001",    "amount_minor": 0,    "currency": "GBP",    "source_type": "string",    "source_id": "00000000-0000-4000-8000-000000000001",    "status": "scheduled",    "collection_date": "string",    "notice_date": "string",    "submission_date": "string",    "already_scheduled": true  }}