Amend or cancel BACS paper mandate [beta]

Amend or cancel a previously created BACS direct debit paper mandate.

The requested operation is validated against the mandate's current status and version, the pending intent is persisted with an optimistic-lock version bump, and the operation is enqueued for the asynchronous submission worker to forward to Form3. The endpoint does not call Form3 directly.

State rules:

  • amend is allowed only from CREATED, SUBMITTED, or CONFIRMED, and moves the mandate to AMEND_PENDING.
  • cancel is allowed only from SUBMITTED or CONFIRMED, and moves the mandate to CANCEL_PENDING.
  • An invalid source state returns 409 Conflict.

Optimistic concurrency: the caller sends the version it last observed. If it does not match the stored version, or the mandate is modified concurrently, the request is rejected with 409 Conflict. On success the version is incremented by 1.

This endpoint generates a BACS paper mandate status changed event with status = AMEND_PENDING (amend) or CANCEL_PENDING (cancel).

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

Amend or cancel paper mandate request body

Payload to amend or cancel an existing paper mandate. debtor and beneficiary are required when operation is amend and are ignored for cancel.

string
enum
required

Operation to apply to an existing paper mandate.

  • amend - Update the mandate's debtor and beneficiary details. Requires debtor and beneficiary
  • cancel - Cancel the mandate
Allowed:
integer
required

Caller's expected current mandate version, used for optimistic concurrency control.

debtor
object

Debtor (payer) bank details captured from the signed paper mandate form.

beneficiary
object

Beneficiary (creditor) details. Account number and sort code are optional paying-bank details.

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