DirectDebit Integration guide
Initiate a direct debit in just a few simple steps.
This document describes the required API flow for initiating and managing direct debit (SEPA) transactions. It covers both the first-time mandate flow and the subsequent direct debit flow using an existing mandate. The procedures below are the required implementation order for a correct and reliable integration.
Mandate
A object representing a customer’s authorization for SEPA direct debit collections. It stores the mandateId, type (single, recurring, flexible), and should be linked to a customer.
A mandate is identified through the IO token: IO-####-####-####
We know three different types of mandates.
Single Mandate:
A mandate authorizing one SEPA direct debit transaction. It is valid for a single collection only.
The DirectDebits collection will be done automatically.
Recurring Mandate: A mandate that authorizes automatic, repeated SEPA direct debits at a predefined interval (e.g., monthly). Payments are executed on a fixed schedule, for a fixed time. The DirectDebits collection will be done automatically.
Flexible Mandate: A mandate that authorizes multiple SEPA direct debit transactions without a predefined amount or schedule. DirectDebits can be triggered at any time. The first DirectDebits, during the mandate:create is processed automatically, while all subsequent collections must be initiated via the DirectDebits:Add API endpoint.
DirectDebits
A transaction object representing an actual payment request initiated using a mandate. Each direct debit references a mandateId and contains details such as the amount, date and a description. Its status must be validated via DirectDebits:GET to confirm success or failure.
A DirectDebits is identified through the IL token: IL-####-####-####",
Important: a mandate is considered active only after the first DirectDebit has been successfully processed and the funds have been deducted from the customer’s bank account. All subsequent direct debits using this mandate depend on this initial successful transaction.
DirectDebits exchange calls
DirectDebits has its own exchange calls, more information about this is available here.
Updated 5 days ago