POST
Cancel direct debit collection
Use this when the account holder wants to stop a direct debit collection that is still INITIATED or PENDING (not yet settled). Identify those rows via isDirectDebit: true on list payment requests (or ?isDirectDebit=true). Poll payment requests until status is FAILED. If cancel fails at ClearBank, status may revert to INITIATED or PENDING.
Cutoff: 09:00 Europe/Amsterdam on the collection day (or once collection-day funding stamps nonCancellable). After that, cancellation returns 409. Unfunded collections are refused automatically by the daily scheduler — no customer cancel needed.

Authorizations

Authorization
string
header
required

The user's id_token from authentication — the ID token, not the access_token. The program and environment come from the token.

Path Parameters

customerId
string
required

Customer identifier.

accountId
string
required

Account identifier. The account determines which optional features and limits apply.

paymentRequestId
string
required

Response

Cancellation accepted (in flight). Body is the raw handler result (not wrapped by apiResponseMiddleware).

status
enum<string>
required
Available options:
PENDING_CANCELLATION
paymentRequestId
string
required