All Docs
Getting StartedagentOS Direct DebitUpdated March 20, 2026

Introducing the DD Account Setup Wizard

Introducing the DD Account Setup Wizard

Release: v1.0.78

Setting up Direct Debit collection for a new organisation now has a clear, guided path. Version 1.0.78 ships a dedicated DD Account Setup Wizard that walks new letting agents through every configuration step required before they can start collecting rent via Direct Debit.


Why This Matters

Before this release, there was no enforced onboarding sequence for Direct Debit configuration. Agents could reach an incomplete state — missing credentials, no holding account, or no reserve settings — that would cause collection failures later. The new wizard makes the required steps explicit, validates credentials immediately against the Modulr and Griffin APIs, and gates mandate invites behind a completed setup checklist.


The Four-Step Wizard

Step 1 — Modulr Credentials

Enter your Modulr Service User Number (SUN) and API credentials. These are used to register AUDDIS mandates and submit BACS collection requests. The wizard validates the credentials against the Modulr API in real time — you cannot proceed with invalid credentials.

Step 2 — Griffin Credentials & Holding Account

Enter your Griffin API credentials, then either:

  • Select an existing Griffin account to use as the DD holding account, or
  • Create a new holding account directly from the wizard.

Griffin credentials are validated live before the account selection step is shown.

Step 3 — Hold Period & Reserve Settings

Configure two key parameters that control how funds move through the system:

SettingDescriptionDefault
Hold PeriodHow long (in hours) collected funds are held in the Griffin holding account before being forwarded to the agent's client account.24 hours
Reserve Risk FactorMultiplier used to calculate the clawback reserve requirement.Configurable
Reserve Minimum ThresholdMinimum balance that must remain in the holding account at all times.Configurable

These settings can be updated later via the API, but sensible defaults must be confirmed before setup is marked complete.

Step 4 — Test Mandate Invite

Send a test mandate invite to a nominated email address. This confirms the end-to-end flow — from invite generation through to mandate form delivery — is working correctly with your credentials and account configuration.


Setup Checklist

A persistent checklist is shown throughout the wizard and on the organisation dashboard. Each step is marked complete only once its validation has passed:

  • Modulr credentials verified
  • Griffin credentials verified
  • Holding account selected or created
  • Hold period and reserve settings confirmed
  • Test mandate invite sent

Gatekeeping

Mandate invites are blocked for any organisation that has not completed the setup wizard. Attempting to send an invite via the API before setup is complete will return an error indicating which steps remain outstanding. This prevents partial configurations from reaching tenants.


Getting Started

  1. Create your organisation via the API or admin UI.
  2. You will be immediately directed into the DD Account Setup Wizard.
  3. Complete all four steps in order.
  4. Once the checklist is fully checked, mandate invites are unlocked.

If you need to revisit any setting after initial setup — for example, to rotate API credentials or adjust the hold period — those operations remain available via the API and admin UI.