Create BACS paper mandate [beta]

Create a BACS direct debit paper mandate from the details of a signed paper mandate form.

The mandate is imported into Form3 through the PSP gateway, persisted with status CREATED under the account indicated in the account token (role PAYER), and enqueued for the asynchronous submission worker. The endpoint does not call Form3 directly.

Notes:

  • The operation is idempotent via the Idempotency-key header. Repeating the same key replays the original mandate; reusing the same reference with a different key is rejected with a 409 Conflict.

  • This endpoint creates the mandate with status = CREATED, which does not generate an event. Subsequent status transitions generate a BACS paper mandate status changed event (for example: SUBMITTED, CONFIRMED, CANCELLED, FAILED).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create paper mandate request body

Payload to create a paper mandate.

debtor
object
required

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

beneficiary
object
required

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

string
required
^[0-9]{6}$

Six-digit clearing ID for the paper mandate.

string
required
length ≤ 18

Mandate reference. Must be unique per organization.

string
required

Processing date. Format = yyyy-mm-dd

Headers
string
required

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

string
required
length ≤ 32

A UUID (without hyphens) to ensure the operation remains idempotent, allowing for operation repetition without causing unintended effects or duplication. Identifies the transaction on future events.

Responses

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