Cancel BACS paper mandate [beta]

Cancel a BACS direct debit paper mandate.

Cancel of an existing paper mandate, applied asynchronously through the BACS scheme.

Notes:

  • The cancel is persisted with status = CANCEL_PENDING under the payer account, and enqueued for the asynchronous submission worker, which submits it to Form3 through the PSP gateway.

  • Allowed only when the mandate is in SUBMITTED or CONFIRMED; any other state is rejected with a 409 Conflict (EBACS0103).

  • version is a Form3 optimistic-concurrency passthrough that must equal the stored version; a mismatch is rejected with a 409 Conflict (EBACS0104). This call does not increment it.

  • The optional status_reason records why the mandate is being cancelled; it is persisted on the mandate and forwarded on the generated event.

  • This endpoint moves the mandate to status = CANCEL_PENDING and generates a BACS paper mandate status changed event. Subsequent status transitions generate further events (for example CANCELLED, FAILED).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 36

Paper mandate ID (the Form3-assigned ID returned at creation).

Body Params

Cancel paper mandate request body

Payload to cancel an existing paper mandate. version is required for optimistic concurrency; status_reason optionally records why the mandate is being cancelled.

integer
required

Caller's expected current mandate version. A Form3 optimistic-concurrency passthrough that must match the stored version; it is not incremented by this call.

string
enum

Reason code for the cancellation (mirrors Form3's paper-mandate cancellation reasons). The client sends only the code; the human-readable description is derived server-side.

  • account_closed - Account closed
  • account_transferred_to_new_psp - Account transferred to a new PSP
  • cancelled_by_originator - Cancelled by originator
  • cancelled_by_payer - Cancelled by payer
  • payer_deceased - Payer deceased
  • paying_bank_cancellation - Paying bank cancellation
Allowed:
Headers
string
required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json