Sign in
latestOpenAPI 3.1.02026-08-105546268.4 KB

f1fef352d976

SEPA Direct Debits

Create a SEPA Direct Debit for a freelancer

Initiates a SEPA Direct Debit from the debtor specified in the request body to the freelancer's account specified in the request URL.

post/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_direct_debit

Path parameters

person_idstring required
account_idstring required

Request body

referencestring

UUID reference for the transaction. Acts as an idempotency key.

descriptionstring

A description for the transaction, which will be visible to the customer and the debtor.

collection_datestring

The date on which to execute the SEPA Direct Debit.

end_to_end_idstring

SEPA identifier provided by the customer initiating the transaction. This value is routed through the entire payment process.

Example request

{
  "reference": "f69f6431-bfb7-4c7e-81ba-8a4f023362c2",
  "amount": {
    "value": 1000,
    "currency": "EUR",
    "unit": "cents"
  },
  "description": "Example transaction",
  "collection_date": "2016-02-11T00:00:00.000Z",
  "mandate": {
    "reference": "1",
    "creditor_identifier": "DE98ZZZ09999999999",
    "scheme": "B2B",
    "sequence_type": "ONE_OFF",
    "signature_date": "2016-02-02T00:00:00.000Z",
    "debtor_name": "Hans Mustermann",
    "debtor_iban": "DE32110101001000000029",
    "debtor_bic": "COBADEFFXXX"
  },
  "end_to_end_id": "ABC123"
}

Response

Successful result of the operation

idstring

Unique ID of the transaction.

status'created' | 'accepted' | 'declined' | 'executed' | 'review_needed' | 'canceled'

The status of the SDD transaction.

referencestring

Optional reference for the transaction. Acts as an idempotency key.

descriptionstring

Optional description for the transaction, which will be visible to the debtor. Limited to 140 characters. Please note the SEPA character restrictions.

collection_datestring

The date on which to collect the direct debit. The default value is the day after the current day. The latest possible date is 14 calendar days in the future.

end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example response

{
  "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  "status": "accepted",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "collection_date": "2021-02-11T00:00:00.000Z",
  "mandate": {
    "reference": "dsf2r3raedfs3fsf342fctrx",
    "creditor_identifier": "DE98ZZZ09999999999",
    "signature_date": "2017-10-02T16:12:41Z",
    "debtor_name": "Hans Mustermann",
    "debtor_iban": "DE29300400000180478000",
    "debtor_bic": "COBADEFFXXX"
  },
  "end_to_end_id": "END2ENDREJ"
}