Amend BACS mandate [beta]

Amend a BACS direct debit mandate.

Registers a change to a mandate's debtor and/or beneficiary details, applied asynchronously through the BACS scheme.

Notes:

  • The amend is persisted with status = AMEND_PENDING, and enqueued for the asynchronous submission worker, which submits it to Form3 through the PSP gateway.

  • Allowed only when the mandate is in CREATED, 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 this field.

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

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

Mandate ID (the Form3-assigned ID returned at creation).

Body Params

Amend mandate request body

Payload to amend an existing mandate. version is required for optimistic concurrency.

integer
required

Caller's expected current mandate version. A Form3 optimistic-concurrency passthrough that must match the stored version. This call does not increment this field.

debtor
object

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

beneficiary
object

Beneficiary (creditor) 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