Schedule a one-off Direct Debit collection
Schedules a one-off Bacs collection against an active mandate for an invoice. 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. An invoice source must be issued and still owe money: a draft or pending_approval invoice is refused, and so are paid, void and other closed invoices (409 invoice_not_collectable at the final check before bureau submission).
/mandates/{id}/collectionsSchedules a one-off Bacs collection against an active mandate for an invoice. 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. An invoice source must be issued and still owe money: a draft or pending_approval invoice is refused, and so are paid, void and other closed invoices (409 invoice_not_collectable at the final check before bureau submission).
Related endpoints
GET /mandates— List Direct Debit mandatesGET /mandates/{id}— Retrieve a Direct Debit mandatePOST /mandates/{id}/cancel— Cancel a Direct Debit mandatePOST /mandates/{id}/suspend— Suspend a Direct Debit mandatePOST /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 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.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.
Authorization
apiKey mandates:writeYour 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
Scope: mandates:write
Path Parameters
Mandate UUID
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Parameters for scheduling a one-off Direct Debit collection against an active mandate. L&Z confirms the permitted collection date; nothing is marked paid until the bureau confirms the collection outcome.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.revkeen.com/v2/mandates/11111111-1111-4111-8111-111111111111/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"
}'Synthetic documentation data, validated against the response schema; not a live API result.
{ "data": { "id": "4e5f6a7b-8c9d-4eba-afcb-3a4b5c6d7e19", "mandate_id": "6a7b8c9d-0e1f-4a32-8c3d-4e5f6a7b8c31", "lz_schedule_id": "LZ-SCH-EXAMPLE-0057", "amount_minor": 5880, "currency": "GBP", "source_type": "invoice", "source_id": "3d4e5f6a-7b8c-4da9-9eba-2f3a4b5c6d08", "status": "scheduled", "collection_date": "2026-05-18", "notice_date": "2026-05-01", "submission_date": "2026-05-13", "already_scheduled": false }}