Create BACS mandate [beta]

Create a BACS direct debit mandate.

A BACS direct debit mandate captures a payer's authorisation, taken from a signed paper form, for a business to collect direct debit payments from their UK bank account through the BACS scheme.

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.

  • Creation does not generate an event. Subsequent status transitions generate a BACS mandate status changed event (for example SUBMITTED, CONFIRMED, FAILED).

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

Create mandate request body

Payload to create a mandate

debtor
object
required

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

beneficiary
object
required

Beneficiary (creditor) details.

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

Six-digit clearing ID for the mandate

string
required
length ≤ 18

Mandate reference. Must be unique per organization and use the standard BACS reference character set.

The standard BACS reference character set is the restricted set of characters BACS permits in the text fields of a Standard 18 record — the format used for Direct Debit/Direct Credit instructions. It maps to the reference field on the mandate schemas.

BACS Standard 18 (STD18) is a fixed-width, 80-to-106-character line-based file format used to submit Direct Credit and Direct Debit payment instructions in the UK. Files strictly follow a defined sequence starting with volume and header labels, proceeding to transaction records, and ending with trailer and total lines.

Permitted characters:

  • Uppercase letters A-Z (lowercase is not allowed — it gets force-uppercased)
  • Digits 0-9
  • Space
  • These four specials only: - (hyphen), . (full stop), & (ampersand), / (solidus)

Reference-field rules on top of the character set:

  • 6–18 characters
  • Must not begin with a space
  • Must not be all the same character (e.g. all zeros)
  • First 4 chars must not be DDIC (reserved for bank/indemnity-claim use)
  • Should be unique per Direct Debit
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