DirectDebit

Integration with third-party direct debit platforms. Provides endpoints to list payers (customers), create payers, list mandates, and create mandates. The direct debit platform is determined by Tenant.DirectDebitConnectionCode which references a ThirdPartyConnection with DirectDebit capability. A payer can have multiple mandates (e.g., different bank accounts). Create mandate returns authorization URL for customer approval.

OpenAPI Spec

Guides Operations Schemas

GET List DirectDebit Payers
Lists all payers (customers) from the direct debit platform Requires: ViewAll on ClientBilling.
/tenants/{tenant}/direct-debit/payers
GET List DirectDebit Mandates
Lists mandates from the direct debit platform for a specific payer. Requires payerId. Requires: ViewAll on ClientBilling.
/tenants/{tenant}/direct-debit/mandates
GET Get DirectDebit Mandate
Gets a specific mandate to check its status Requires: ViewAll on ClientBilling.
/tenants/{tenant}/direct-debit/mandates/{mandateId}
POST Send Direct Debit Setup Email
Sends an email to the client asking them to complete the Direct Debit setup process. Includes a {Url} for them to visit. The ContentBlock for the emai...
/tenants/{tenant}/direct-debit/setup/send-email
GET Complete Direct Debit Setup
Callback endpoint for completing direct debit mandate setup after customer authorization. The DirectDebit provider will redirect the user here after t...
/direct-debit/setup/callback
GET Get Direct Debit Settings
Returns the direct debit settings for the specified tenant Requires: ViewAll on PracticeDetails.
/tenants/{tenant}/direct-debit/settings
PUT Update Direct Debit Settings
Updates the direct debit settings for the specified tenant Requires: Update on PracticeDetails.
/tenants/{tenant}/direct-debit/settings