All Docs
FeaturesagentOS Direct DebitUpdated March 13, 2026

DD Customer Onboarding: SUN & Account Setup Wizard

DD Customer Onboarding: SUN & Account Setup Wizard

Version 1.0.70 introduces a dedicated Direct Debit configuration wizard into the agent onboarding flow. This step appears immediately after organisation creation and must be completed before onboarding can finish.

Overview

When a new letting agent signs up, they now complete a multi-field DD setup wizard that links their Modulr and Griffin accounts to the Direct Debit service, sets fund-holding behaviour, and registers alert contacts. Every field is validated against the respective external API before the configuration is saved.

Wizard Steps

1. Modulr Configuration

Agents provide the Modulr credentials that identify their Direct Debit service setup:

FieldDescription
Service User Number (SUN)The BACS-issued SUN that identifies the agent as a Direct Debit originator in Modulr.
Modulr Account ID(s)The Modulr account identifier(s) used for collection processing.

Both fields are validated live against the Modulr API. An error is shown inline if validation fails, and the step cannot be advanced until validation passes.

2. Griffin Configuration

Agents provide their Griffin banking account details:

FieldDescription
DD Holding Account IDThe Griffin account where collected funds are swept and held during the hold period.
Client Account IDThe Griffin account to which funds are forwarded after the hold period.

Both IDs are validated against the Griffin API before the step is marked complete.

3. Hold Period & Reserve Thresholds

Agents configure the financial controls that govern fund forwarding:

FieldDescription
Hold PeriodDuration (in hours) that funds remain in the Griffin holding account before being forwarded. Default: 24 hours.
Reserve Risk FactorMultiplier used to calculate the required clawback reserve from recent collection history.
Minimum Reserve AmountFloor value (GBP) for the clawback reserve, regardless of the risk factor calculation.

4. Alert Recipient Emails

Agents add one or more email addresses to receive operational alerts. Alerts are triggered when configurable thresholds are breached, including:

  • Mandate creation rate exceeding the configured limit
  • Daily or weekly collection amounts exceeding thresholds
  • Clawback reserve dropping below the minimum

At least one email address must be entered before this step can be completed.

Validation & Completion Gate

Onboarding cannot be completed until:

  1. All Modulr fields are saved and validated successfully against the Modulr API.
  2. All Griffin fields are saved and validated successfully against the Griffin API.
  3. Hold period and reserve thresholds are set and saved.
  4. At least one alert recipient email is configured.

Any API validation failure surfaces an inline error message on the relevant field. The "Complete Onboarding" action remains disabled until every step passes.

Impact on Existing Customers

Customers who completed onboarding before v1.0.70 are unaffected. Their Direct Debit configuration is managed through the standard organisation settings interface rather than the onboarding wizard.