Summary: New Deposits endpoints to list and retrieve bank transfers and SEPA Direct Debit deposits, and a new deposit.collect_with_mandate action for workflows to set up recurring SEPA Direct Debit collections

Deposits

New Endpoints: List and Get Deposits

Documented new endpoints to retrieve a customer account's deposits. Bank transfers and SEPA Direct Debit deposits are returned in the same shape; a SEPA Direct Debit deposit names its payment_instrument_mandate and the workflow that collected it. The current status is the latest entry in history.

• GET /accounts/{account_id}/deposits - List deposits, optionally filtered by status (* returns every status), payment_instrument_mandate, workflow, creditor.iban, creditor.cash_account and debtor.iban
• GET /accounts/{account_id}/deposits/{deposit_id} - Retrieve a deposit

Workflows

New Action: Recurring SEPA Direct Debit collections

Workflows can now collect a fixed EUR amount from the customer's bank account on a weekly or monthly schedule, using the customer's confirmed payment instrument mandate, into one of the customer account's own cash accounts. POST /accounts/{account_id}/workflows accepts the new deposit.collect_with_mandate action together with the schedule trigger. Collection workflows are confirmed, retrieved, listed and canceled like other workflows.

The SEPA Direct Debit guide walks through the full flow, from creating and confirming the mandate to creating and confirming the collection workflow. Limits and errors are documented in the API reference.

Direct-debit collections are available on request and are enabled per partner. To enable them, contact your partner manager.

Deposit Events for Collections

Each collection is a deposit with payment_instrument_mandate set. For a collection, deposit.created is sent a few days before the collection date to announce it, before any money has arrived; send the customer a pre-notification when you receive it. deposit.received follows once the amount is credited. The new deposit.canceled event is sent when an announced collection is canceled with its workflow or mandate.

Schema changes

EventType gains deposit.canceled. ActionType gains deposit.collect_with_mandate, and ActionDataRequest and ActionDataResponse carry the new deposit object (CollectWithMandateDataRequest and CollectWithMandateDataResponse). The request and response format of existing workflows is unchanged.