Skip to content
/SEPA Direct Debits

SEPA transfers (1.0)

Download OpenAPI description
sepa-transfers.json
sepa-transfers.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/sepa-transfers/

SEPA Direct Debits

Operations

Create a SEPA Direct Debit for a freelancer

Request

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

Path
person_idstringrequired
account_idstringrequired
Bodyapplication/json

The content of the request.

referencestring

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

Example: "f69f6431-bfb7-4c7e-81ba-8a4f023362c2"
amountobject

The amount to debit from the debtor.

Example: {"value":1000,"currency":"EUR","unit":"cents"}
descriptionstring

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

Example: "Example transaction"
collection_datestring

The date on which to execute the SEPA Direct Debit.

Example: "2016-02-11T00:00:00.000Z"
mandateobject

Object containing information about the direct debit mandate.

Example: {"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_idstring

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

Example: "ABC123"
application/json
{
  "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"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "074ff24d187a014f42d5694b13e9cf1fctrx"
statusstring

The status of the SDD transaction.

Enum"created""accepted""declined""executed""review_needed""canceled"
Example: "accepted"
referencestring

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

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount to debit from the external account.

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.

Example: "2021-02-11T00:00:00.000Z"
mandateobject

Object containing information about the direct debit mandate.

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: "END2ENDREJ"
Response
application/json
{
  "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  "status": "accepted",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "collection_date": "2021-02-11T00:00:00.000Z",
  "mandate": {
    "reference": "dsf2r3raedfs3fsf342fctrx",
    "creditor_identifier": "DE98ZZZ09999999999",
    "scheme": "string",
    "sequence_type": "string",
    "signature_date": "2017-10-02T16:12:41Z",
    "debtor_name": "Hans Mustermann",
    "debtor_iban": "DE29300400000180478000",
    "debtor_bic": "COBADEFFXXX"
  },
  "end_to_end_id": "END2ENDREJ"
}

Retrieve a SEPA Direct Debit for a freelancer

Request

Returns information about the SEPA Direct Debit specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "074ff24d187a014f42d5694b13e9cf1fctrx"
statusstring

The status of the SDD transaction.

Enum"created""accepted""declined""executed""review_needed""canceled"
Example: "accepted"
referencestring

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

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount to debit from the external account.

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.

Example: "2021-02-11T00:00:00.000Z"
mandateobject

Object containing information about the direct debit mandate.

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: "END2ENDREJ"
Response
application/json
{
  "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  "status": "accepted",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "collection_date": "2021-02-11T00:00:00.000Z",
  "mandate": {
    "reference": "dsf2r3raedfs3fsf342fctrx",
    "creditor_identifier": "DE98ZZZ09999999999",
    "scheme": "string",
    "sequence_type": "string",
    "signature_date": "2017-10-02T16:12:41Z",
    "debtor_name": "Hans Mustermann",
    "debtor_iban": "DE29300400000180478000",
    "debtor_bic": "COBADEFFXXX"
  },
  "end_to_end_id": "END2ENDREJ"
}

Create a SEPA Direct Debit to a billing account

Request

Initiates a SEPA Direct Debit transaction from an external account (i.e., your customer account) to your billing account. You must add the account_id of your billing account in the request URL.

Path
account_idstringrequired
Bodyapplication/json

The content of the request.

referencestring

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

amountobject

The amount to debit from the external account.

Example: {"value":1000,"currency":"EUR","unit":"cents"}
descriptionstring

Optional description for the transaction, which will be visible to the debtor. Limited to 140 characters.

Example: "Example transaction"
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.

Example: "2016-02-11T00:00:00.000Z"
mandateobject

Object containing information about the direct debit mandate.

Example: {"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_idstring

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

Example: "ABC123"
application/json
{
  "reference": "",
  "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"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "074ff24d187a014f42d5694b13e9cf1fctrx"
statusstring

The status of the SDD transaction.

Enum"created""accepted""declined""executed""review_needed""canceled"
Example: "accepted"
referencestring

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

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount to debit from the external account.

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.

Example: "2021-02-11T00:00:00.000Z"
mandateobject

Object containing information about the direct debit mandate.

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: "END2ENDREJ"
Response
application/json
{
  "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  "status": "accepted",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "collection_date": "2021-02-11T00:00:00.000Z",
  "mandate": {
    "reference": "dsf2r3raedfs3fsf342fctrx",
    "creditor_identifier": "DE98ZZZ09999999999",
    "scheme": "string",
    "sequence_type": "string",
    "signature_date": "2017-10-02T16:12:41Z",
    "debtor_name": "Hans Mustermann",
    "debtor_iban": "DE29300400000180478000",
    "debtor_bic": "COBADEFFXXX"
  },
  "end_to_end_id": "END2ENDREJ"
}

Get a SEPA Direct Debit transaction to a billing account

Request

Returns the details of a single SEPA Direct Debit transaction. You must add the account_id of your billing account and the sepa_direct_debit_id in the request URL.

Path
account_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "074ff24d187a014f42d5694b13e9cf1fctrx"
statusstring

The status of the SDD transaction.

Enum"created""accepted""declined""executed""review_needed""canceled"
Example: "accepted"
referencestring

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

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount to debit from the external account.

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.

Example: "2021-02-11T00:00:00.000Z"
mandateobject

Object containing information about the direct debit mandate.

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: "END2ENDREJ"
Response
application/json
{
  "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  "status": "accepted",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "collection_date": "2021-02-11T00:00:00.000Z",
  "mandate": {
    "reference": "dsf2r3raedfs3fsf342fctrx",
    "creditor_identifier": "DE98ZZZ09999999999",
    "scheme": "string",
    "sequence_type": "string",
    "signature_date": "2017-10-02T16:12:41Z",
    "debtor_name": "Hans Mustermann",
    "debtor_iban": "DE29300400000180478000",
    "debtor_bic": "COBADEFFXXX"
  },
  "end_to_end_id": "END2ENDREJ"
}

Fetch pending SEPA Direct Debits for an account

Request

Returns an array containing all upcoming pending SDDs for the specified account for which we've been notified about by any creditor bank, including Solaris. This endpoint will not return SDDs that have been already executed.

Path
account_idstringrequired

Unique identifier of a customer's account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Query
page[number]string

Returns a specific page of results.

page[size]string

Determines the size of each page of results.

No request payload

Responses

Successfully fetched the Pending SDDs.

Bodyapplication/jsonArray [
descriptionstring

A description for the SDD transaction, which is visible to the customer.

Example: "inv:123cust:456"
purpose_codestring

Purpose of the transaction.

Example: "SALA"
end_to_end_idstring

Reference for transaction.

Example: "REFX123X123X456"
transaction_idstring

Unique ID of the transaction. Same as the transaction ID in the booking resource.

Example: "49a57d88276df2e440cdd2e7eec291ctrx"
valuta_datestring(date)

The transaction date.

Example: "2024-12-12"
amountobject

The amount of the SDD transaction in Euro cents.

creditor_namestring

The name of the creditor.

Example: "Alice Musterfrau"
creditor_ibanstring

The creditor IBAN.

Example: "DE84110101019999999999"
creditor_bicstring

The creditor BIC.

Example: "BANKDEBBXXX"
debtor_namestring

The name of the debtor.

Example: "Bob Mustermann"
debtor_ibanstring

The debtor IBAN.

Example: "DE75110101013333333333"
debtor_bicstring

The debtor BIC.

Example: "SOBKDEB2XXX"
requested_collection_datestring(date)

The date on which the SDD transaction will be collected.

Example: "2024-12-10"
collection_sequencestring

The sequence of the SDD collection.

Enum"FRST""RCUR""OOFF""FNAL"
Example: "FRST"
mandate_schemestring
Enum"CORE""B2B"
Example: "CORE"
mandate_creditor_idstring

The unique ID of the creditor mandate.

Example: "DE00ZZZ00000000005"
mandate_date_of_signaturestring(date)

The date on which the customer signed the SDD mandate.

Example: "2024-12-10"
mandate_referencestring

Reference value for the SDD mandate.

Example: "M000000001"
]
Response
application/json
[
  {
    "description": "inv:123cust:456",
    "purpose_code": "SALA",
    "end_to_end_id": "REFX123X123X456",
    "transaction_id": "49a57d88276df2e440cdd2e7eec291ctrx",
    "valuta_date": "2024-12-12",
    "amount": { … },
    "creditor_name": "Alice Musterfrau",
    "creditor_iban": "DE84110101019999999999",
    "creditor_bic": "BANKDEBBXXX",
    "debtor_name": "Bob Mustermann",
    "debtor_iban": "DE75110101013333333333",
    "debtor_bic": "SOBKDEB2XXX",
    "requested_collection_date": "2024-12-10",
    "collection_sequence": "FRST",
    "mandate_scheme": "CORE",
    "mandate_creditor_id": "DE00ZZZ00000000005",
    "mandate_date_of_signature": "2024-12-10",
    "mandate_reference": "M000000001"
  }
]

SEPA Direct Debit Returns

Operations

SEPA Credit Transfers

Operations

(Legacy) Batch Transfer

Operations

SEPA Instant Credit Transfers

Operations

(Legacy) Standing orders

Operations

(Legacy) Timed orders

Operations

SDD Collection Limits

Operations

SDD Collection Applications

Operations

SDD Collections

Operations

SEPA Credit Batch Transfers

Operations

Scheduled Transfers

Operations

Sepa Instant Limits

Operations

Verification of Payee

Operations

(Legacy) SEPA Direct Debit for freelancers

Operations

(Legacy) SEPA Direct Debit for business

Operations

(Legacy) SEPA Direct Debit profile templates

Operations