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.
-
GET List DirectDebit PayersLists all payers (customers) from the direct debit platform/tenants/{tenant}/direct-debit/payers
-
GET List DirectDebit MandatesLists mandates from the direct debit platform for a specific payer. Requires payerId./tenants/{tenant}/direct-debit/mandates
-
GET Get DirectDebit MandateGets a specific mandate to check its status/tenants/{tenant}/direct-debit/mandates/{mandateId}
-
POST Send Direct Debit Setup EmailSends 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 SetupCallback 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 SettingsReturns the direct debit settings for the specified tenant/tenants/{tenant}/direct-debit/settings
-
PUT Update Direct Debit SettingsUpdates the direct debit settings for the specified tenant/tenants/{tenant}/direct-debit/settings