SEPA transfers (1.0)

Download OpenAPI specification:Download

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.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json

The content of the request.

reference
string

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

object

The amount to debit from the debtor.

description
string

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

collection_date
string

The date on which to execute the SEPA Direct Debit.

object

Object containing information about the direct debit mandate.

end_to_end_id
string

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

Responses
201

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_direct_debit
Request samples
application/json
{
  • "reference": "f69f6431-bfb7-4c7e-81ba-8a4f023362c2",
  • "amount": {
    },
  • "description": "Example transaction",
  • "collection_date": "2016-02-11T00:00:00.000Z",
  • "mandate": {
    },
  • "end_to_end_id": "ABC123"
}
Response samples
application/json
{
  • "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  • "status": "accepted",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "collection_date": "2021-02-11T00:00:00.000Z",
  • "mandate": {
    },
  • "end_to_end_id": "END2ENDREJ"
}

Retrieve a SEPA Direct Debit for a freelancer

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

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_direct_debit/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_direct_debit/{id}'
Response samples
application/json
{
  • "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  • "status": "accepted",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "collection_date": "2021-02-11T00:00:00.000Z",
  • "mandate": {
    },
  • "end_to_end_id": "END2ENDREJ"
}

Create a SEPA Direct Debit to a billing account

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.

Request
Security:
path Parameters
account_id
required
string
Request Body schema: application/json

The content of the request.

reference
string

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

object

The amount to debit from the external account.

description
string

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

collection_date
string

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.

object

Object containing information about the direct debit mandate.

end_to_end_id
string

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

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/accounts/{account_id}/transactions/sepa_direct_debit
Request samples
application/json
{
  • "reference": "",
  • "amount": {
    },
  • "description": "Example transaction",
  • "collection_date": "2016-02-11T00:00:00.000Z",
  • "mandate": {
    },
  • "end_to_end_id": "ABC123"
}
Response samples
application/json
{
  • "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  • "status": "accepted",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "collection_date": "2021-02-11T00:00:00.000Z",
  • "mandate": {
    },
  • "end_to_end_id": "END2ENDREJ"
}

Get a SEPA Direct Debit transaction to a billing account

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.

Request
Security:
path Parameters
account_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/accounts/{account_id}/transactions/sepa_direct_debit/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/accounts/{account_id}/transactions/sepa_direct_debit/{id}'
Response samples
application/json
{
  • "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  • "status": "accepted",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "collection_date": "2021-02-11T00:00:00.000Z",
  • "mandate": {
    },
  • "end_to_end_id": "END2ENDREJ"
}

SEPA Direct Debit Returns

Create a SEPA Direct Debit refund

Refunds a SEPA Direct Debit transaction for a freelancer.
Note that the refund request will be rejected if any of the following criteria are met:

  • The account is inactive.
  • The account is blocked (for any reason).
  • The SDD was already returned.
  • The amount is positive.
  • The valuta date is older than 56 days (i.e., 8 weeks). You can refund older SDDs by contacting Solaris customer support (up to 13 months from the valuta date).

Note: This call triggers the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json

The content of the request.

booking_id
required
string

The ID of the SEPA Direct Debit booking resource to be refunded.

reason
string

A description of why the SDD should be refunded.

Responses
200

The operation has been previously performed. Result of the previous operation.

201

The change request was successfully confirmed, and the SDD return request is created.

202

The request was accepted, and now the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/sepa_direct_debit_returns
Request samples
application/json
{
  • "booking_id": "16d088c2-14ff-5da1-a373-b7b4623befca",
  • "reason": "Example reason"
}
Response samples
application/json
{
  • "id": "be6b2a68-2c93-4d39-b56e-0897b8137473"
}

SEPA Credit Transfers

Create SEPA Credit Transfer

Creates a SEPA Credit Transfer from the account specified in the request URL to the recipient specified in the request body.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json

The content of the request.

reference
required
string

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

recipient_name
required
string

The recipient's name.

recipient_iban
required
string

The recipient's IBAN.

recipient_bic
string

The recipient's BIC.

required
object

The amount to transfer.

description
string

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

end_to_end_id
string

End-to-end ID to use for the transaction.

change_request_enabled
boolean
Default: true

If set to true, then the customer initiating the transaction will receive a change request 2FA challenge. If false, then the legacy 2FA challenge will be used.

Responses
200

This transaction already exists.

201

Successful result of the operation for the legacy 2FA method.

202

The request was accepted, and the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer
Request samples
application/json
{
  • "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  • "recipient_name": "Hans Mustermann",
  • "recipient_iban": "DE32110101001000000029",
  • "recipient_bic": "COBADEFFXXX",
  • "amount": {
    },
  • "description": "Example transaction",
  • "end_to_end_id": "",
  • "change_request_enabled": true
}
Response samples
application/json
{
  • "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  • "status": "executed",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Max Mustermann",
  • "recipient_bic": "SOBKDEB2XXX",
  • "end_to_end_id": "END2ENDREJ",
  • "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  • "created_at": "2021-01-01T20:37:50Z"
}

Index SEPA Credit Transfers for a person's account

Returns an array containing all SEPA Credit Transfers for the person account specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

filter[status]
string

Filter on the status of the SepaCreditTransaction

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer?page%5Bnumber%5D=string&page%5Bsize%5D=string&filter%5Bstatus%5D=string'
Response samples
application/json
[
  • {
    }
]

Retrieve a SEPA Credit Transfer

Returns information about the SEPA Credit Transfer specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer/{id}'
Response samples
application/json
{
  • "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  • "status": "executed",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Max Mustermann",
  • "recipient_bic": "SOBKDEB2XXX",
  • "end_to_end_id": "END2ENDREJ",
  • "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  • "created_at": "2021-01-01T20:37:50Z"
}

Create a SEPA Credit Transfer from a billing account

Creates a SEPA Credit Transfer from the billing account specified in the request URL to the account specified in the request body.

Request
Security:
path Parameters
account_id
required
string
Request Body schema: application/json

The content of the request.

reference
string

Optional reference for the transaction. Will act as an idempotency key.

recipient_name
string

The recipient's name.

recipient_iban
required
string

The recipient's IBAN.

recipient_bic
string

The recipient's BIC.

object

The amount to transfer to the recipient.

description
string

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

end_to_end_id
string

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

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/accounts/{account_id}/transactions/sepa_credit_transfer
Request samples
application/json
{
  • "reference": "",
  • "recipient_name": "Hans Mustermann",
  • "recipient_iban": "DE32110101001000000029",
  • "recipient_bic": "COBADEFFXXX",
  • "amount": {
    },
  • "description": "Example transaction",
  • "end_to_end_id": ""
}
Response samples
application/json
{
  • "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  • "status": "executed",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Max Mustermann",
  • "recipient_bic": "SOBKDEB2XXX",
  • "end_to_end_id": "END2ENDREJ",
  • "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  • "created_at": "2021-01-01T20:37:50Z"
}

Show a SEPA Credit Transfer from a billing account

Returns the details of a single SEPA Credit Transfer transaction. You must add the account_id of your billing account and the transaction id in the request URL.

Request
Security:
path Parameters
account_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/accounts/{account_id}/transactions/sepa_credit_transfer/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/accounts/{account_id}/transactions/sepa_credit_transfer/{id}'
Response samples
application/json
{
  • "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  • "status": "executed",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Max Mustermann",
  • "recipient_bic": "SOBKDEB2XXX",
  • "end_to_end_id": "END2ENDREJ",
  • "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  • "created_at": "2021-01-01T20:37:50Z"
}

(Legacy) Authorize SEPA Credit Transfer

Initiates a 2FA challenge to the customer for a SEPA Credit Transfer. This endpoint is deprecated; please use the change request service instead.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Request Body schema: application/json

The content of the request.

delivery_method
string

The method to use for delivering the 2FA challenge to the customer.

Enum: "device_signing" "mobile_number"
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer/{id}/authorize
Request samples
application/json
{
  • "delivery_method": "device_signing"
}
Response samples
application/json
{
  • "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  • "status": "executed",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Max Mustermann",
  • "recipient_bic": "SOBKDEB2XXX",
  • "end_to_end_id": "END2ENDREJ",
  • "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  • "created_at": "2021-01-01T20:37:50Z"
}

(Legacy) Confirm SEPA Credit Transfer

Submits the authorization code from a 2FA challenge to confirm a SEPA Credit Transfer. This endpoint is deprecated; please use the change request service instead.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Request Body schema: application/json

The content of the request.

authorization_token
string

The authorization token from the 2FA challenge.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer/{id}/confirm
Request samples
application/json
{
  • "authorization_token": ""
}
Response samples
application/json
{
  • "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  • "status": "executed",
  • "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  • "amount": {
    },
  • "description": "string",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Max Mustermann",
  • "recipient_bic": "SOBKDEB2XXX",
  • "end_to_end_id": "END2ENDREJ",
  • "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  • "created_at": "2021-01-01T20:37:50Z"
}

SEPA Credit Batch Transfer

Create SEPA Credit Transfer batch

Creates a SEPA Credit Transfer batch. This call triggers the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json

The content of the request.

Array of objects (Solaris-Server-Decorators-SepaCreditTransaction)

An array of SEPA Credit Transfers to execute.

Responses
201

The change request was successfully confirmed, and the batch order is created.

202

The request is accepted, and the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer/batches
Request samples
application/json
{
  • "transactions": [
    ]
}
Response samples
application/json
{
  • "id": "bba471db8ec4ef5a84e0bfb0022e45bfsctb",
  • "status": "SUCCESSFUL",
  • "sepa_credit_transfers": {
    },
  • "errors": { }
}

Retrieve SEPA Credit Transfer batch

Returns information about a SEPA Credit Transfer batch.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer/batches/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/transactions/sepa_credit_transfer/batches/{id}'
Response samples
application/json
{
  • "id": "bba471db8ec4ef5a84e0bfb0022e45bfsctb",
  • "status": "SUCCESSFUL",
  • "sepa_credit_transfers": {
    },
  • "errors": { }
}

SEPA Instant Credit Transfers

Check the reachability of a bank via SEPA Instant Credit Transfer

Checks if you can send a SEPA Instant Credit Transfer to the IBAN provided or not. Use this endpoint to check the reachability of the recipient's bank before creating a transfer. If the IBAN's reachability is true, you can use the POST Create a SEPA Instant Credit Transfer endpoint to initiate the transfer. If the IBAN's reachability is false, the transaction will fail. You can use the standard SEPA Credit Transfer instead.

Request
Security:
path Parameters
iban
required
string

The recipient's IBAN.

Responses
200

Successful result of the operation

400

There was an error on the client side.

403

You are not authorized to perform this action.

404

The model could not be found.

500

Internal server error.

default

Unexpected error

get/v1/sepa_instant_reachability/{iban}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/sepa_instant_reachability/{iban}'
Response samples
application/json
{
  • "sct_instant_reachability": true
}

Create a SEPA Instant Credit Transfer

Creates a SEPA Instant Credit Transfer on the account specified in the request URL and triggers the 2FA flow via change request. You must add the transaction details in the request body.

Request
Security:
path Parameters
account_id
required
string

The ID of the customer's account from which the SCT Instant will be transferred.

Request Body schema: application/json

Information required to create the SCT.

required
object

The transaction amount.

creditor_iban
required
string

The IBAN of the creditor account (i.e., the account holder receiving the money). The IBAN must be reachable via SCT Instant!

creditor_name
required
string <= 70 characters

The name of the creditor (i.e., account holder).

description
string <= 140 characters

A description for the transaction given by the customer.

end_to_end_id
string <= 35 characters

Your unique end-to-end ID for the transaction.

initiator_reference
string

Your unique reference for the transaction.

idempotency_key
string <uuid>

Your unique value generated for the transaction, which Solaris uses to recognize subsequent retries of the same request.

Responses
202

Change request for the transaction was created

400

There was an error on the client side.

403

You are not authorized to perform this action.

404

The model could not be found.

500

Internal server error.

default

Unexpected error

post/v1/accounts/{account_id}/transactions/sepa_instant_credit_transfers
Request samples
application/json
{
  • "amount": {
    },
  • "creditor_iban": "Lisa Herrmann",
  • "creditor_name": "DE02500105170137075030",
  • "description": "Geschenk",
  • "end_to_end_id": "e2178fc8b9ad4a479e269a47f90b4a43",
  • "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
  • "idempotency_key": "7352a11b-011d-47a4-a449-17371078e98c"
}
Response samples
application/json
{}

Index all SEPA Instant Credit Transfers for an account

Returns a list of all SEPA Instant Credit Transfers for the account specified in the request URL. You can filter the results by the creditor_iban, transaction status, etc.

Request
Security:
path Parameters
account_id
required
string

The ID of the customer's account from which the SCT Instant will be transferred.

query Parameters
page[number]
integer

The number of results pages to return.

page[size]
integer

The size of each page in the response.

filter[status]
string (TransactionStatus)

Filters the results by the transaction status.

Enum: "INITIATED" "RESERVED" "READY_FOR_CLEARING" "CLEARED"
filter[creditor_iban]
string

Filters the results by the creditor IBAN.

Responses
200

Successful result of the operation

400

There was an error on the client side.

403

You are not authorized to perform this action.

404

The model could not be found.

500

Internal server error.

default

Unexpected error

get/v1/accounts/{account_id}/transactions/sepa_instant_credit_transfers
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/accounts/{account_id}/transactions/sepa_instant_credit_transfers?page%5Bnumber%5D=0&page%5Bsize%5D=0&filter%5Bstatus%5D=INITIATED&filter%5Bcreditor_iban%5D=string'
Response samples
application/json
[
  • {
    }
]

Standing orders

Create standing order

Creates a standing order for the person account specified in the request URL. Note: This call triggers the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json

The content of the request.

transaction_type
string

The type of transaction to be executed by the standing order.

Enum: "SEPA_CREDIT_TRANSACTION" "CREDIT_CLEARING_TRANSACTION"
reference
required
string

A reference for the standing order.

clearing_profile_id
string

ID of the clearing profile from which the customer information will be retrieved.

booking_type
string

The booking type to use in this standing order's transactions.

Enum: "SEPA_CREDIT_TRANSACTION" "CREDIT_CLEARING_TRANSACTION" "CRYPTO_EXCHANGE"
recipient_name
string

The recipient's name.

recipient_iban
string

The recipient's IBAN.

recipient_bic
string

The recipient's BIC.

first_execution_date
required
string

The date on which to execute the standing order for the first time.

required
object

The amount of the standing order transaction (in Euro cents).

description
string

A description for the standing order.

end_to_end_id
string

End-to-end ID to use in the standing order transactions.

last_execution_date
string

The date on which to execute the standing order for the last time.

month_end_execution
boolean

Flag to indicate whether the standing order should be executed at the end of the month (for monthly standing orders).

reoccurrence
required
string

The frequency at which to execute the standing order.

Enum: "WEEKLY" "BIWEEKLY" "MONTHLY" "QUARTERLY" "EVERY_SIX_MONTHS" "ANNUALLY"
Responses
201

The change request was successfully confirmed, and the standing order successful.

202

The request is accepted, and the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/standing_orders
Request samples
application/json
{
  • "transaction_type": "SEPA_CREDIT_TRANSACTION",
  • "reference": "unique-reference",
  • "booking_type": "SEPA_CREDIT_TRANSACTION",
  • "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
  • "recipient_name": "Hans Mustermann",
  • "recipient_iban": "DE32110101001000000029",
  • "recipient_bic": "COBADEFFXXX",
  • "first_execution_date": "2017-04-01T00:00:00.000Z",
  • "amount": {
    },
  • "description": "Example standing order",
  • "end_to_end_id": "unique-end-to-end-id",
  • "last_execution_date": "2018-04-01T00:00:00.000Z",
  • "month_end_execution": true,
  • "reoccurrence": "MONTHLY"
}
Response samples
application/json
{
  • "id": "f874b3102718a4d757a6b6e4d599607ccsto",
  • "status": "ACTIVE",
  • "booking_type": "SEPA_CREDIT_TRANSFER",
  • "transaction_type": "SEPA_CREDIT_TRANSFER",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Hans Mustermann",
  • "recipient_bic": "COBADEFFXXX",
  • "reference": "dsf2r3raedfs3fsf342fctrx",
  • "amount": {
    },
  • "description": "string",
  • "first_execution_date": "2021-09-01",
  • "last_execution_date": "2025-09-01",
  • "reoccurrence": "MONTHLY",
  • "end_to_end_id": "END2ENDREJ",
  • "month_end_execution": true,
  • "next_occurrence": "2021-10-01"
}

Index standing orders

Returns an array containing all standing orders for the person account specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

filter[transaction_type]
string

Filter the results by transaction type.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/standing_orders
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/standing_orders?page%5Bnumber%5D=string&page%5Bsize%5D=string&filter%5Btransaction_type%5D=string'
Response samples
application/json
[
  • {
    }
]

Index standing orders

Returns an array containing all standing orders for your customers.

Request
Security:
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

filter[transaction_type]
string

Filter the results by transaction type.

filter[next_occurrence]
required
string

Filters the results to include only standing orders that are scheduled to execute on a given date.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/standing_orders
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/standing_orders?page%5Bnumber%5D=string&page%5Bsize%5D=string&filter%5Btransaction_type%5D=string&filter%5Bnext_occurrence%5D=string'
Response samples
application/json
[
  • {
    }
]

Retrieve a standing order

Returns information about the standing order specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
standing_order_id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}'
Response samples
application/json
{
  • "id": "f874b3102718a4d757a6b6e4d599607ccsto",
  • "status": "ACTIVE",
  • "booking_type": "SEPA_CREDIT_TRANSFER",
  • "transaction_type": "SEPA_CREDIT_TRANSFER",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Hans Mustermann",
  • "recipient_bic": "COBADEFFXXX",
  • "reference": "dsf2r3raedfs3fsf342fctrx",
  • "amount": {
    },
  • "description": "string",
  • "first_execution_date": "2021-09-01",
  • "last_execution_date": "2025-09-01",
  • "reoccurrence": "MONTHLY",
  • "end_to_end_id": "END2ENDREJ",
  • "month_end_execution": true,
  • "next_occurrence": "2021-10-01"
}

Update a standing order

Modifies one or more properties on a standing order. Note that the customer must have already authorized and confirmed the standing order. Note: This call triggers the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
standing_order_id
required
string
Request Body schema: application/json

The content of the request.

object

The amount of the standing order (in Euro cents).

description
string

A description for the standing order.

end_to_end_id
string

The standing order's end-to-end ID.

last_execution_date
string

The date when the standing order should be executed for the last time.

month_end_execution
boolean

Flag to determine whether the standing order should be executed at the end of the month.

reoccurrence
string

Determines how often the standing order should be executed.

Enum: "WEEKLY" "BIWEEKLY" "MONTHLY" "QUARTERLY" "EVERY_SIX_MONTHS" "ANNUALLY"
Responses
201

The change request was successfully confirmed, and the standing order has been modified.

202

The request is accepted, and the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

patch/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}
Request samples
application/json
{
  • "amount": {
    },
  • "description": "Example standing order",
  • "end_to_end_id": "unique-end-to-end-id",
  • "last_execution_date": "2018-04-01T00:00:00.000Z",
  • "month_end_execution": true,
  • "reoccurrence": "MONTHLY"
}
Response samples
application/json
{
  • "id": "f874b3102718a4d757a6b6e4d599607ccsto",
  • "status": "ACTIVE",
  • "booking_type": "SEPA_CREDIT_TRANSFER",
  • "transaction_type": "SEPA_CREDIT_TRANSFER",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Hans Mustermann",
  • "recipient_bic": "COBADEFFXXX",
  • "reference": "dsf2r3raedfs3fsf342fctrx",
  • "amount": {
    },
  • "description": "string",
  • "first_execution_date": "2021-09-01",
  • "last_execution_date": "2025-09-01",
  • "reoccurrence": "MONTHLY",
  • "end_to_end_id": "END2ENDREJ",
  • "month_end_execution": true,
  • "next_occurrence": "2021-10-01"
}

Execute a standing order

Executes the standing order specified in the request URL on the date of its next occurrence.

Request
Security:
path Parameters
standing_order_id
required
string
Request Body schema: application/json

The content of the request.

description
string
Responses
202

The request was accepted. The transaction will be executed when the standing order is scheduled to occur next.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

patch/v1/standing_orders/{standing_order_id}/execute
Request samples
application/json
{
  • "description": "A description for the transaction."
}
Response samples
application/json
{
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "code": "build_pagination_headers_failure",
  • "title": "Failed to build pagination headers.",
  • "detail": "Cannot connect to database."
}

Cancel standing order

Cancels a standing order. Note that the customer must already have authorized and confirmed the standing order. Note: This call triggers the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
standing_order_id
required
string
Responses
201

The change request was successfully confirmed, and the standing order is canceled.

202

The request is accepted, and the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

patch/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}/cancel
Request samples
curl -i -X PATCH \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}/cancel'
Response samples
application/json
{
  • "id": "f874b3102718a4d757a6b6e4d599607ccsto",
  • "status": "ACTIVE",
  • "booking_type": "SEPA_CREDIT_TRANSFER",
  • "transaction_type": "SEPA_CREDIT_TRANSFER",
  • "recipient_iban": "DE87110101001000057123",
  • "recipient_name": "Hans Mustermann",
  • "recipient_bic": "COBADEFFXXX",
  • "reference": "dsf2r3raedfs3fsf342fctrx",
  • "amount": {
    },
  • "description": "string",
  • "first_execution_date": "2021-09-01",
  • "last_execution_date": "2025-09-01",
  • "reoccurrence": "MONTHLY",
  • "end_to_end_id": "END2ENDREJ",
  • "month_end_execution": true,
  • "next_occurrence": "2021-10-01"
}

List all SEPA Credit Transfers issued by a standing order

Returns an array containing all SEPA Credit Transfers issued by the standing order specified in the request URL since its creation.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
standing_order_id
required
string
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}/sepa_credit_transfers
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}/sepa_credit_transfers?page%5Bnumber%5D=string&page%5Bsize%5D=string'
Response samples
application/json
[
  • {
    }
]

Index credit clearing transactions issued by a standing order

Returns an array containing all credit clearing transactions issued by the standing order specified in the request URL since its creation.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
standing_order_id
required
string
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}/credit_clearing_transactions
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/standing_orders/{standing_order_id}/credit_clearing_transactions?page%5Bnumber%5D=string&page%5Bsize%5D=string'
Response samples
application/json
[
  • {
    }
]

Timed orders

Create a timed order

Creates a timed order from the account specified in the request URL to the recipient specified in the request body.
Timed orders are executed every day from 7:00 to 20:00 on each hour. Most timed orders are executed at 7:00, but all timed orders created on the same day as their execution date will be executed at the next available hour. Note: This call triggers the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json

The content of the request.

change_request_enabled
boolean
Default: true

Deprecated field. Use the value true.

execute_at
required
string

The date when the timed order should be executed.

required
object
Responses
200

The change request was successfully confirmed, and the timed order is successful.

202

The request was accepted, and now the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/timed_orders
Request samples
application/json
{
  • "change_request_enabled": true,
  • "execute_at": "2018-01-01T00:00:00.000Z",
  • "transaction": {
    }
}
Response samples
application/json
{
  • "id": "411e69f14d3533da53b9b0a73161c3fectrx",
  • "execute_at": "2021-07-22",
  • "executed_at": "2021-07-22",
  • "status": "SCHEDULED",
  • "scheduled_transaction": {
    }
}

Index timed orders for a given account

Returns an array containing all timed orders from the account specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/timed_orders
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/timed_orders?page%5Bnumber%5D=string&page%5Bsize%5D=string'
Response samples
application/json
[
  • {
    }
]

Authorize a timed orderDeprecated

Deprecated method. Timed orders are now authorized using the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Request Body schema: application/json

The content of the request.

delivery_method
string

The type of delivery method to use for the change request 2FA challenge.

Enum: "mobile_number" "device_binding"
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/timed_orders/{id}/authorize
Request samples
application/json
{
  • "delivery_method": "device_binding"
}
Response samples
application/json
{
  • "id": "411e69f14d3533da53b9b0a73161c3fectrx",
  • "execute_at": "2021-07-22",
  • "executed_at": "2021-07-22",
  • "status": "SCHEDULED",
  • "scheduled_transaction": {
    }
}

Confirm a timed orderDeprecated

Deprecated method. Timed orders are now confirmed using the change request process.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Request Body schema: application/json

The content of the request.

authorization_token
string

Authorization Token

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/accounts/{account_id}/timed_orders/{id}/confirm
Request samples
application/json
{
  • "authorization_token": ""
}
Response samples
application/json
{
  • "id": "411e69f14d3533da53b9b0a73161c3fectrx",
  • "execute_at": "2021-07-22",
  • "executed_at": "2021-07-22",
  • "status": "SCHEDULED",
  • "scheduled_transaction": {
    }
}

Retrieve a timed order

Displays information about the timed order specified in the request URL. The response includes the related SEPA Credit Transfer.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/accounts/{account_id}/timed_orders/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/timed_orders/{id}'
Response samples
application/json
{
  • "id": "411e69f14d3533da53b9b0a73161c3fectrx",
  • "execute_at": "2021-07-22",
  • "executed_at": "2021-07-22",
  • "status": "SCHEDULED",
  • "scheduled_transaction": {
    }
}

Cancel a timed order

Cancels the timed order specified in the request URL. The status of the timed order will change to CANCELED, and the scheduled transaction will never be executed.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
id
required
string
Responses
200

The change request was successfully confirmed, and the timed order is canceled.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

patch/v1/persons/{person_id}/accounts/{account_id}/timed_orders/{id}/cancel
Request samples
curl -i -X PATCH \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/timed_orders/{id}/cancel'
Response samples
application/json
{
  • "id": "411e69f14d3533da53b9b0a73161c3fectrx",
  • "execute_at": "2021-07-22",
  • "executed_at": "2021-07-22",
  • "status": "SCHEDULED",
  • "scheduled_transaction": {
    }
}

SDD Collection Limits

Create SDD collection limit

Creates an SDD collection limit on the account specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json
comment
string

A comment to append to the SDD collection limit.

required
object

The limit of the SDD collection.

limit_type
string

The type of SDD collection limit. Use the value CUSTOMER_REQUEST.

Value: "CUSTOMER_REQUEST"
Responses
201

The SDD collection limit was successfully created.

403

You are not authorized to perform this action.

404

The resource could not be found.

post/v1/persons/{person_id}/accounts/{account_id}/sdd_collection_limits
Request samples
application/json
{
  • "comment": "Comment",
  • "limit": {
    },
  • "limit_type": "CUSTOMER_REQUEST"
}
Response samples
application/json
{
  • "id": "f4ed772c970e1096a73d9418192a2d0camsg",
  • "limit": {
    },
  • "limit_type": "EXTERNAL",
  • "current_limit": true,
  • "created_at": "2021-10-20T14:45:54Z",
  • "comments": [
    ]
}

Index SDD collection limits for an account

Returns an array containing all active SDD collection limits for the account specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
query Parameters
page[size]
integer
Default: 10

Specifies the number of resources to return in each page of results.

page[number]
integer
Default: 1

Specifies the number of pages of results to return.

filter[id]
string

Filter the results by the ID of the resource.

filter[limit_type]
string

Filter the results by the limit type.

Responses
200

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

get/v1/persons/{person_id}/accounts/{account_id}/sdd_collection_limits
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/sdd_collection_limits?page%5Bsize%5D=10&page%5Bnumber%5D=1&filter%5Bid%5D=string&filter%5Blimit_type%5D=string'
Response samples
application/json
{
  • "id": "f4ed772c970e1096a73d9418192a2d0camsg",
  • "limit": {
    },
  • "limit_type": "EXTERNAL",
  • "current_limit": true,
  • "created_at": "2021-10-20T14:45:54Z",
  • "comments": [
    ]
}

Delete SDD collection limit

Disables the active SDD collection limit for the account specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
query Parameters
limit_type
required
string

Specifies the limit type to return.

comment
string
Responses
204

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

delete/v1/persons/{person_id}/accounts/{account_id}/sdd_collection_limits
Request samples
curl -i -X DELETE \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/sdd_collection_limits?limit_type=string&comment=string'
Response samples
application/json
null

SDD Collection Applications

Create an SDD collection application

Creates an application for an SDD collection for the person specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json
credit_record_id
required
string

ID of the credit record (created using POST /persons/{person_id}/credit_records).

Responses
201

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

post/v1/persons/{person_id}/sdd_collection_applications
Request samples
application/json
{
  • "credit_record_id": "84f468eacc7a4784ba0d4b0b577a9265"
}
Response samples
application/json
[
  • {
    }
]

Index SDD collection applications

Returns a list of all SDD collection applications for the person specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
query Parameters
page[size]
integer
Default: 10

Specifies the number of resources to return in each page of results.

page[number]
integer
Default: 1

Specifies the number of pages of results to return.

filter[status]
string

Filter the results by status.

Responses
200

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

get/v1/persons/{person_id}/sdd_collection_applications
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/sdd_collection_applications?page%5Bsize%5D=10&page%5Bnumber%5D=1&filter%5Bstatus%5D=string'
Response samples
application/json
[
  • {
    }
]

Attach account to an SDD collection application

Attaches an internal account to the SDD collection application specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
sdd_collection_application_id
required
string
Request Body schema: application/json
account_id
required
string

ID of the relevant account

Responses
204

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

put/v1/persons/{person_id}/sdd_collection_applications/{sdd_collection_application_id}/account
Request samples
application/json
{
  • "account_id": "string"
}
Response samples
application/json
null

Link account snapshot to an SDD collection application

Links an account snapshot to the SDD collection application specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
sdd_collection_application_id
required
string
Request Body schema: application/json
account_snapshot_id
required
string

ID of the account snapshot to attach to the SDD collection application

Responses
204

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

put/v1/persons/{person_id}/sdd_collection_applications/{sdd_collection_application_id}/account_snapshot
Request samples
application/json
{
  • "account_snapshot_id": "string"
}
Response samples
application/json
null

Retrieve an SDD collection application

Returns the SDD collection application specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
sdd_collection_application_id
required
string
Responses
200

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

get/v1/persons/{person_id}/sdd_collection_applications/{sdd_collection_application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/sdd_collection_applications/{sdd_collection_application_id}'
Response samples
application/json
{
  • "id": "dec2961f594045159195ca66e55fd6ea",
  • "person_id": "ec71f4b0456b424b97cc8be75b2c77d4",
  • "credit_record_id": "84f468eacc7a4784ba0d4b0b577a9265",
  • "sdd_collection_id": "c06fbfcc98b04376a9f220c4578932e4",
  • "account_snapshot_id": "973a5f01ed7a416fadfed954c5bce782",
  • "status": "pending",
  • "decision": "OFFERED",
  • "rejection_reasons": [
    ],
  • "created_at": "2021-10-20T14:45:54Z",
  • "limit": {
    }
}

SDD Collections

Retrieve an SDD collection

Returns the active SDD collection for the account specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Responses
200

The operation was successful.

403

You are not authorized to perform this action.

404

The resource could not be found.

get/v1/persons/{person_id}/accounts/{account_id}/sdd_collection
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/sdd_collection'
Response samples
application/json
{
  • "id": "c06fbfcc98b04376a9f220c4578932e4",
  • "status": "created",
  • "limit": {
    }
}

(Legacy) SEPA Direct Debit for freelancers

Create a SEPA Direct Debit profile for a freelancerDeprecated

Creates a SEPA Direct Debit profile and assigns it to the freelancer with the given person_id. For this method, you must supply information from the credit bureau report generated for the freelancer.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json

Details of the SEPA Direct Debit profile to be assigned to the freelancer.

credit_bureau_pd
number

The probability of default (PD) rating assigned by the credit bureau. The value must be in decimals.

date_of_report
string

Date when the credit bureau report was generated.

credit_bureau_name
string

The name of the credit bureau that generated the report. Possible values are SCHUFA and CREDITFORM.

Enum: "CREDITFORM" "SCHUFA"
founding_date
string

(For businesses only) Date when the company was founded.

terms_and_conditions_signed_at
string

The timestamp of the moment when the business customer signed the terms and conditions for the partner's SEPA Direct Debit product.

Responses
202

The request has been accepted for processing.

400

Client error.

403

Unauthorized action.

404

The person with the supplied person_id could not be found.

409

The provided SEPA Direct Debit profile has already been assigned.

500

Internal server error.

post/persons/{person_id}/direct_debit_profile
Request samples
application/json
{
  • "credit_bureau_pd": 0.02,
  • "date_of_report": "2020-02-12",
  • "credit_bureau_name": "CREDITFORM",
  • "founding_date": "2018-01-01",
  • "terms_and_conditions_signed_at": "20-01-01T00:00:00Z"
}
Response samples
application/json
{
  • "id": "3cab044c-edf8-4443-841d-489547177469",
  • "status": "ACCEPTED",
  • "status_reasons": "string",
  • "collection_limit": {
    },
  • "single_sdd_limit": {
    }
}

List all direct debit profiles for a freelancerDeprecated

Returns an array of direct debit profiles that belong to the freelancer with the given person_id.

Request
Security:
path Parameters
person_id
required
string
query Parameters
filter[status]
string

(Optional) Append this parameter to the query to filter the results by profile status.

Responses
200

Operation was successful.

400

Client error.

403

Unauthorized action.

404

The person with the supplied person_id could not be found.

500

Internal server error.

get/persons/{person_id}/direct_debit_profiles
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/persons/{person_id}/direct_debit_profiles?filter%5Bstatus%5D=string'
Response samples
application/json
[
  • {
    }
]

Create a SEPA Direct Debit transaction for a freelancerDeprecated

Validates and initiates a SEPA Direct Debit transaction from an external account to the freelancer's account with the given account_id. The account owner (designated by the person_id) must already have an active SEPA Direct Debit profile assigned.

Request
Security:
path Parameters
person_id
required
string
account_id
required
string
Request Body schema: application/json

Details of the SEPA Direct Debit transaction to be executed.

reference
string

Unique reference for the transaction, generated by the partner. Acts as an idempotency key.

object

Object containing the amount to be debited from the specified account.

description
string

Description of the transaction, which can be seen by the recipient. Please note the SEPA character restrictions.

collection_date
string

Date of the SEPA Direct Debit collection. Default value is TODAY + 1. The latest possible date is 14 calendar days in the future.

object (SEPA-Direct-Debit-Transaction-Mandate)

Object containing the direct debit mandate information.

end_to_end_id
string

SEPA identifier, which is routed through the entire payment process. Please note the SEPA character restrictions.

Responses
201

The SEPA Direct Debit transaction was successfully created.

400

Client error.

403

Unauthorized action.

500

Internal server error.

default

Unexpected error

post/persons/{person_id}/accounts/{account_id}/sepa_direct_debit
Request samples
application/json
{
  • "reference": "1612646471",
  • "amount": {
    },
  • "description": "Example transaction",
  • "collection_date": "2016-02-11",
  • "mandate": {
    },
  • "end_to_end_id": "DDHHDHG333243"
}
Response samples
application/json
{
  • "id": "f6b1c9d2b9938bc6228d3db618f2fe3bdtx",
  • "status": "accepted",
  • "reference": "1612646471",
  • "amount": {
    },
  • "description": "Example transaction",
  • "collection_date": "2016-02-11",
  • "mandate": {
    },
  • "end_to_end_id": "DDHHDHG333243",
  • "created_at": "2022-07-08T10:42:29.000Z",
  • "updated_at": "2022-07-08T10:42:29.000Z"
}

Get remaining SEPA Direct Debit collection limit for a freelancerDeprecated

Returns the remaining SEPA Direct Debit collection limit for the current month per account for the freelancer with the given person_id.

Request
Security:
path Parameters
person_id
required
string
Responses
200

Operation was successful.

default

Unexpected error.

get/persons/{person_id}/direct_debit_remaining_limit
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/persons/{person_id}/direct_debit_remaining_limit'
Response samples
application/json
{
  • "remaining_limit": {
    }
}

(Legacy) SEPA Direct Debit for business

Create a SEPA Direct Debit profile for a businessDeprecated

Creates a SEPA Direct Debit profile and assigns it to the business with the given business_id. For this method, you must supply information from the credit bureau report generated for the business customer.

Request
Security:
path Parameters
business_id
required
string
Request Body schema: application/json

Details of the SEPA Direct Debit profile to be assigned to the freelancer.

credit_bureau_pd
number

The probability of default (PD) rating assigned by the credit bureau. The value must be in decimals.

date_of_report
string

Date when the credit bureau report was generated.

credit_bureau_name
string

The name of the credit bureau that generated the report. Possible values are SCHUFA and CREDITFORM.

Enum: "CREDITFORM" "SCHUFA"
founding_date
string

(For businesses only) Date when the company was founded.

terms_and_conditions_signed_at
string

The timestamp of the moment when the business customer signed the terms and conditions for the partner's SEPA Direct Debit product.

Responses
202

The request has been accepted for processing.

400

Client error.

403

Unauthorized action.

404

The business with the supplied business_id could not be found.

409

The business already has a SEPA Direct Debit profile assigned.

500

Internal server error

post/businesses/{business_id}/direct_debit_profile
Request samples
application/json
{
  • "credit_bureau_pd": 0.02,
  • "date_of_report": "2020-02-12",
  • "credit_bureau_name": "CREDITFORM",
  • "founding_date": "2018-01-01",
  • "terms_and_conditions_signed_at": "20-01-01T00:00:00Z"
}
Response samples
application/json
{
  • "id": "3cab044c-edf8-4443-841d-489547177469",
  • "status": "ACCEPTED",
  • "status_reasons": "string",
  • "collection_limit": {
    },
  • "single_sdd_limit": {
    }
}

List all direct debit profiles for a businessDeprecated

Returns an array of direct debit profiles that belong to the business customer with the given business_id.

Request
Security:
path Parameters
business_id
required
string
query Parameters
filter[status]
string

(Optional) Append this parameter to the query to filter the results by profile status.

Responses
200

Operation was successful.

400

Client error.

403

Unauthorized action.

404

The business with the supplied business_id could not be found.

500

Internal server error.

get/businesses/{business_id}/direct_debit_profiles
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/businesses/{business_id}/direct_debit_profiles?filter%5Bstatus%5D=string'
Response samples
application/json
[
  • {
    }
]

Create a SEPA Direct Debit transaction for a businessDeprecated

Validates and initiates a SEPA Direct Debit transaction from an external account to the account with the given account_id. The account owner (designated by the business_id) must already have an active SEPA Direct Debit profile assigned.

Request
Security:
path Parameters
business_id
required
string
account_id
required
string
Request Body schema: application/json

Details of the SEPA Direct Debit transaction to be executed.

reference
string

Unique reference for the transaction, generated by the partner. Acts as an idempotency key.

object

Object containing the amount to be debited from the specified account.

description
string

Description of the transaction, which can be seen by the recipient. Please note the SEPA character restrictions.

collection_date
string

Date of the SEPA Direct Debit collection. Default value is TODAY + 1. The latest possible date is 14 calendar days in the future.

object (SEPA-Direct-Debit-Transaction-Mandate)

Object containing the direct debit mandate information.

end_to_end_id
string

SEPA identifier, which is routed through the entire payment process. Please note the SEPA character restrictions.

Responses
201

The SEPA Direct Debit transaction was successfully created.

400

Client error.

403

Unauthorized action.

500

Internal server error.

default

Unexpected error

post/businesses/{business_id}/accounts/{account_id}/sepa_direct_debit
Request samples
application/json
{
  • "reference": "1612646471",
  • "amount": {
    },
  • "description": "Example transaction",
  • "collection_date": "2016-02-11",
  • "mandate": {
    },
  • "end_to_end_id": "DDHHDHG333243"
}
Response samples
application/json
{
  • "id": "f6b1c9d2b9938bc6228d3db618f2fe3bdtx",
  • "status": "accepted",
  • "reference": "1612646471",
  • "amount": {
    },
  • "description": "Example transaction",
  • "collection_date": "2016-02-11",
  • "mandate": {
    },
  • "end_to_end_id": "DDHHDHG333243",
  • "created_at": "2022-07-08T10:42:29.000Z",
  • "updated_at": "2022-07-08T10:42:29.000Z"
}

Get remaining SEPA Direct Debit collection limit for a businessDeprecated

Returns the remaining SEPA Direct Debit collection limit for the current month per account for the business customer with the given business_id.

Request
Security:
path Parameters
business_id
required
string
Responses
200

Operation was successful.

default

Unexpected error

get/businesses/{business_id}/direct_debit_remaining_limit
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/businesses/{business_id}/direct_debit_remaining_limit'
Response samples
application/json
{
  • "remaining_limit": {
    }
}

(Legacy) SEPA Direct Debit profile templates

Show SEPA Direct Debit profile templatesDeprecated

Returns an array containing all SEPA Direct Debit profile templates.

Request
Security:
Responses
200

Operation was successful.

default

Unexpected error

get/direct_debit_profile_templates
Request samples
curl -i -X GET \
  https://api.solaris-sandbox.de/direct_debit_profile_templates
Response samples
application/json
[
  • {
    }
]