Direct debits

View as Markdown
Standing charges against your customer's accounts. Each entry carries the creditor, the mandate reference, the account charged, the amounts seen and the periodicity the institution reports. Field by field in [Direct debits](/guides/data-models/banking/direct-debits). <Tip> **The fastest read of somebody's fixed costs.** Rent, utilities, insurance, subscriptions — the recurring commitments, without parsing every transaction of every account to find them. </Tip> <Note title="Requires the `direct_debits_read` feature"> Features are chosen when the execution **starts**, not here. An execution that did not ask for `direct_debits_read` answers `204`, and the only way to get the data is to run another one. </Note> | Status | Meaning | | :--- | :--- | | `200` | The mandates. | | `202` | `feature_not_ready` — `direct_debits_read` is still running. **Only this family waits**: the ones that already closed answer now. | | `204` | The execution never asked for `direct_debits_read`. No body. | | `404` | No execution with that id for your application, or it has been deleted. | <Note> **Server to server only.** This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read. </Note>

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
The SEPA mandates charged against the accounts: who collects, how often, and how much the last charges were. It is the cheapest read of somebody’s recurring commitments.

An empty list is an answer, not a gap: the feature ran and the source reported none.

idstringformat: "object-id"
Product ID for the current execution. It may change between executions.
product"direct_debit"
sub_family"direct_debit:sepa"
fetch_datestringformat: "datetime"
Date this product was fetched.
accountobject
The customer's account the debit is charged to.
statusenum
Status of the direct debit authorization.
customer_segmentenum
Whether the account belongs to a personal or a business relationship.
beneficiaryobject
Who collects the debit.
payerobject
Who pays the debit.
transactionslist of objects
Recent charges of this debit, as reported by the bank.
debit_referencestringOptional

Mandate/debit reference, as the bank reports it.

attachmentslist of objectsOptionalDefaults to []

Supporting documents of the debit — e.g. the receipt of the most recent charge. Each entry’s id downloads the file through the execution’s attachments endpoint.

Errors

404
Not Found Error
422
Unprocessable Entity Error