Skip to content
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/account-management/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Creates a statement of account (Rechnungsabschluss) for the account specified in the request URL. Use the information returned in the response to generate your own branded PDF file to present to the customer. This file must include the entire data set returned by our API without exception, including the mandatory disclaimer text.
In the request, you must specify a year along with an interval and a period. Together, the interval and period determine the statement's beginning and end dates (statement_period_start_date and statement_period_end_date). For example, if you make a request with an interval of MONTHLY, a period of 3, and a year of 2022, then the API will return a statement of account for the month of March 2022. If the API returns an error related to the start and end dates, then the interval and period could not be translated into dates (e.g., an invalid enum was passed) or the given interval fell outside of the allowed time frame (e.g., in the future).

Path
account_idstringrequired
Bodyapplication/json

The content of the request.

intervalstringrequired

Determines the amount of time that the statement of account should cover.

Enum"MONTHLY""QUARTERLY""EVERY_SIX_MONTHS""ANNUALLY"
Example: "MONTHLY"
periodintegerrequired

Determines the starting period in the year from which to return bookings.

Enum12345678910
Example: 3
yearintegerrequired

The year for which to create the statement of account.

Example: 2022
application/json
{ "interval": "MONTHLY", "period": 3, "year": 2022 }

Responses

A statement for account has already been created based on the provided values.

Bodyapplication/json
idstring

Unique ID of the statement.

Example: "e349cdc6b712035236bed32d7399ab72csoa"
yearinteger

The year for which the statement was created.

Example: 2022
intervalstring

The time interval covered by the statement.

Enum"MONTHLY""QUARTERLY""EVERY_SIX_MONTHS""ANNUALLY"
Example: "MONTHLY"
periodinteger

The period from which the statement interval begins.

Example: 3
statement_numberstring

The statement number.

Example: "2022-M-03"
recipient_informationobject

The statement recipient's name and address.

issue_datestring(date)

Date when the statement was issued.

Example: "2022-04-01"
statement_period_start_datestring(date)

The beginning date of the period covered by the statement.

Example: "2022-03-01"
statement_period_end_datestring(date)

The end date of the period covered by the statement.

Example: "2022-03-31"
overdraft_facilityobject

Overdraft facility that has been granted to the customer.

Example: {"value":10000,"unit":"cents","currency":"EUR"}
interest_accrual_ratenumber(float)

The daily rate at which interest is accrued on the used amount of an overdraft.

Example: 12.5
overdraft_rateinteger(float)

The increased interest rate applied when going below the granted overdraft facility.

Example: 9
interest_accruedobject

The interest accrued in EURO cents.

Example: {"value":10000,"unit":"cents","currency":"EUR"}
account_informationobject

Object containing the account's IBAN, BIC, and balance information.

disclaimerstring

Solaris' legal disclaimer text, which you must show to the customer.

Example: "Sehr geehrte Kundin, sehr geehrter Kunde,\\nbitte prüfen Sie die Buchungen, Berechnungen und den Abschlusssaldo im beiliegenden Kontoauszug, der zugleich einen Rechnungsabschluss darstellt. Rechnungsabschlüsse gelten als genehmigt, sofern Sie innerhalb von sechs Wochen nach Zugang keine Einwendungen erheben. Einwendungen gegen Rechnungsabschlüsse müssen der solarisBank schriftlich oder in Textform (z.B. an support@solarisgroup.com) zugehen. Im Falle der Einwendung in Textform genügt zur Fristwahrung die rechtzeitige Absendung. Der angegebene Kontostand berücksichtigt nicht die Wertstellung der einzelnen Buchungen. Dies bedeutet, dass der genannte Betrag nicht dem für die Zinsrechnung maßgeblichen Kontostand entsprechen muss und bei Verfügungen möglicherweise Zinsen für die Inanspruchnahme einer eingeräumten oder geduldeten Kontoüberziehung anfallen können. Gutschriften aus eingereichten Lastschriften und anderen Einzugspapieren erfolgen unter dem Vorbehalt der Einlösung. Guthaben sind als Einlagen nach Maßgabe des Einlagensicherungsgesetzes entschädigungsfähig. Nähere Informationen können dem Informationsbogen für den Einleger entnommen werden, den Sie gemeinsam mit unseren für den Geschäftsverkehr mit Ihnen geltenden Allgemeinen Geschäftsbedingungen und besonderen Bedingungen unter www.solarisbank.de/partner einsehen können.\\nMit freundlichen Grüßen\\nIhre solarisBank"
Response
application/json
{ "id": "e349cdc6b712035236bed32d7399ab72csoa", "year": 2022, "interval": "MONTHLY", "period": 3, "statement_number": "2022-M-03", "recipient_information": { "line_1": "Mr. Peter Mustermann", "line_2": "Musterstrasse 23", "line_3": "10409 Berlin", "line_4": "DE", "line_5": "string", "line_6": "string" }, "issue_date": "2022-04-01", "statement_period_start_date": "2022-03-01", "statement_period_end_date": "2022-03-31", "overdraft_facility": { "value": 10000, "unit": "cents", "currency": "EUR" }, "interest_accrual_rate": 12.5, "overdraft_rate": 9, "interest_accrued": { "value": 10000, "unit": "cents", "currency": "EUR" }, "account_information": { "iban": "DE76110101001100000999", "bic": "SOBKDEBBXXX", "balance_start": {}, "balance_end": {} }, "disclaimer": "Sehr geehrte Kundin, sehr geehrter Kunde,\\nbitte prüfen Sie die Buchungen, Berechnungen und den Abschlusssaldo im beiliegenden Kontoauszug, der zugleich einen Rechnungsabschluss darstellt. Rechnungsabschlüsse gelten als genehmigt, sofern Sie innerhalb von sechs Wochen nach Zugang keine Einwendungen erheben. Einwendungen gegen Rechnungsabschlüsse müssen der solarisBank schriftlich oder in Textform (z.B. an support@solarisgroup.com) zugehen. Im Falle der Einwendung in Textform genügt zur Fristwahrung die rechtzeitige Absendung. Der angegebene Kontostand berücksichtigt nicht die Wertstellung der einzelnen Buchungen. Dies bedeutet, dass der genannte Betrag nicht dem für die Zinsrechnung maßgeblichen Kontostand entsprechen muss und bei Verfügungen möglicherweise Zinsen für die Inanspruchnahme einer eingeräumten oder geduldeten Kontoüberziehung anfallen können. Gutschriften aus eingereichten Lastschriften und anderen Einzugspapieren erfolgen unter dem Vorbehalt der Einlösung. Guthaben sind als Einlagen nach Maßgabe des Einlagensicherungsgesetzes entschädigungsfähig. Nähere Informationen können dem Informationsbogen für den Einleger entnommen werden, den Sie gemeinsam mit unseren für den Geschäftsverkehr mit Ihnen geltenden Allgemeinen Geschäftsbedingungen und besonderen Bedingungen unter www.solarisbank.de/partner einsehen können.\\nMit freundlichen Grüßen\\nIhre solarisBank" }

Index bookings within a statement of account

Request

Returns an array of all bookings with a valuta_date that falls between the start and end dates of the account statement specified in the request URL.

Path
account_idstringrequired
statement_idstringrequired
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

The operation was successful.

Headers
Totalinteger

Total number of bookings within this statement.

Per-Pageinteger

Number of bookings per page.

LinkArray of strings

Links to the first, last, next, and previous pages.

Bodyapplication/json
idstring

ID of the booking.

Example: "fe6561bdb526ed8866e9dac00bd1848ecboo"
creation_datestring

The date when the booking was created. Do not expose this to the account holder(s).

Example: "2022-01-18"
valuta_datestring

The valuta date of the booking (i.e., the date when the booking becomes effective).

Example: "2022-01-18"
booking_datestring

The date when the booking was posted.

Example: "2022-01-18"
booking_typestring(Solaris-Enums-BookingType)

The type of the booking. See the booking documentation for a list of explanations for each booking type.

Enum"CANCELLATION_BOOKING""CancellationCardTransaction""CANCELLATION_CARD_TRANSACTION_DIRECT""CANCELLATION_CHARGE_CARD""CANCELLATION_CHARGE_DUNNING""CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN""CANCELLATION_CRYPTO_EXCHANGE""CANCELLATION_CURRENCY_EXCHANGE_PARTNER""CANCELLATION_DIRECT_DEBIT""CANCELLATION_DOUBLE_BOOKING"
Example: "SEPA_CREDIT_TRANSFER"
amountobject

The amount of the booking.

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

A description of the booking.

Example: "BERLINER VOLKSBANK EG, TXL ABFLUG"
purpose_codestring

The purpose code of the booking.

Example: "null"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEBBXXX"
recipient_ibanstring

The recipient's IBAN.

Example: "DE97110101002242911754"
recipient_namestring

The recipient's full name.

Example: "SURIA LUIS VENTURA VIERA PEREIRA RIBEIRO"
receiver_iban_virtualstring

(If applicable) The receiver's virtual IBAN.

sender_bicstring

The sender's BIC.

Example: "SOBKDEBBXXX"
sender_ibanstring

The sender's IBAN.

Example: "DE95110101000018501020"
sender_namestring

The sender's full name.

Example: "HANS MUSTERMANN"
end_to_end_idstring

SEPA identifier provided by the customer who initiated the SEPA transaction, routed through the entire payment process.

Example: "END2ENDREJ"
creditor_identifierstring

Unique reference that identifies a party collecting payments under the SEPA Direct Debit scheme within and across 32 countries. See the Deutsche Bundesbank's definition of creditor identifier for more information.

Example: "DE98ZZZ09999999999"
mandate_referencestring

The reference of the SDD mandate.

Example: "00000000000001"
transaction_idstring

The Solaris transaction ID.

Example: "d651ee23300b4e7c8fe7b7e2b2e96trx"
return_transaction_idstring

(If applicable) The Solaris ID of the return transaction.

Example: "758ea4a268974284ae7af17871f3fdc4"
sepa_chargesobject

(If applicable) Object containing information about the SEPA Direct Debit return transaction charges.

sepa_return_codestring or null

(If applicable) The SEPA reason code for the return transaction. See the EPC173-14 guidelines for more information.

Enum"AC01""AC03""AC04""AC06""AC13""AC14""AG01""AG02""AM01""AM02"
sepa_return_reasonstring

(If applicable) The SEPA return reason text as defined by ISO 20022.

sepa_return_reason_definitionstring

(If applicable) Explanation of the SEPA return reason code as defined by ISO 20022.

meta_infoobject or null
recorded_atstring

UTC timestamp from when the booking was recorded.

Example: "2022-01-24T00:41:57.634Z"
reconciliation_idstring

(If applicable) Unique ID of the related clearing transaction initiated by Solaris.

Example: "87271dda6e454393036b4ec2b64b2221itrx"
initiator_referencestring

Unique reference for the transaction's initiator.

charge_detailsstring

Transaction charge details. Only relevant for bookings with the type TARGET2_CREDIT_TRANSFER.

Enum"DEBT""SHAR""CRED"
Example: "CRED"
Response
application/json
{ "id": "fe6561bdb526ed8866e9dac00bd1848ecboo", "creation_date": "2022-01-18", "valuta_date": "2022-01-18", "booking_date": "2022-01-18", "booking_type": "SEPA_CREDIT_TRANSFER", "amount": { "value": -160, "unit": "cents", "currency": "EUR" }, "description": "BERLINER VOLKSBANK EG, TXL ABFLUG", "purpose_code": "null", "recipient_bic": "SOBKDEBBXXX", "recipient_iban": "DE97110101002242911754", "recipient_name": "SURIA LUIS VENTURA VIERA PEREIRA RIBEIRO", "receiver_iban_virtual": "string", "sender_bic": "SOBKDEBBXXX", "sender_iban": "DE95110101000018501020", "sender_name": "HANS MUSTERMANN", "end_to_end_id": "END2ENDREJ", "creditor_identifier": "DE98ZZZ09999999999", "mandate_reference": "00000000000001", "transaction_id": "d651ee23300b4e7c8fe7b7e2b2e96trx", "return_transaction_id": "758ea4a268974284ae7af17871f3fdc4", "sepa_charges": { "value": 5000, "unit": "cents", "currency": "EUR" }, "sepa_return_code": "AC01", "sepa_return_reason": "string", "sepa_return_reason_definition": "string", "meta_info": "{\"cards\":{\"card_id\":\"abe6963e8be94364b8c1aa34d1bb5bc3mcrd\",\"merchant\":{\"id\":\"123456789101112\",\"country_code\":\"GB\",\"category_code\":\"5411\",\"name\":\"Grocery\",\"town\":\"London\"},\"original_amount\":{\"currency\":\"GBP\",\"value\":50000,\"fx_rate\":10.0,\"fx_markup\":7.3165,\"issuer_fee\":0.0},\"pos_entry_mode\":\"MANUAL_PAN_ENTRY\",\"trace_id\":\"382621b66280020528d9433d135c2ae418fa53d0\",\"transaction_id\":\"c158f11c-d6b2-4f8f-9391-ac20c2167f89\",\"transaction_date\":\"2024-10-18\",\"transaction_time\":\"2024-10-18T15:22:02+00:00\",\"auth_code\":\"053630\",\"acquirer_id\":\"123456\",\"terminal_id\":\"12345678\",\"transaction_type\":\"PURCHASE\"}}", "recorded_at": "2022-01-24T00:41:57.634Z", "reconciliation_id": "87271dda6e454393036b4ec2b64b2221itrx", "initiator_reference": "string", "charge_details": "CRED" }

(Italy only) Index fees for a statement of account

Request

Returns a list of fees associated with a statement of account. The API returns the type of fee (described in the table below) in the name property of each fee, along with the amount (in EUR cents). The count property indicates the number of times that the given fee was charged.
Note: This endpoint is only relevant for customers with an Italian branch bank account.

name value English description Italian description
InterestOverdraft Interest fee for overdraft Interessi debitori (utilizzo intrafido)
InterestOverdraftExceeded Interest fee for overdraft exceeded Interessi debitori (utilizzo extrafido)
InterestExcessDeposit Negative interest Spese di scritturazione contabile
CorrectionInterestExcessDeposit Correction negative interest Rettifica addebito interessi
InterestFixedTermDeposits Interest credit Interessi creditori
ChargeSEPADirectDebitReturn Charge for SEPA Direct Debit return Spese per la restituzione addebito diretto SEPA
ChargeDunning Fee for dunning letter Spese di invio messa in mora
ChargeRecallRequest Fee for transaction recall Revoca operazioni
ChargeCard Issuing of cards Costi di emissione carta
ChargeAccountMaintenance Account maintenance fee Costi di tenuta del conto
ChargeATM Cash withdrawal Prelievo contanti

Path
account_idstringrequired
statement_idstringrequired
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
namestring

The name of the fee. See the table above for possible values.

countinteger

The number of times this fee was charged during the bank statement period.

amountobject

The total amount charged for this type of fee during the bank statement period.

]
Response
application/json
[ { "name": "string", "count": 0, "amount": {} } ]
Operations
Operations
Operations
Operations
Operations
Operations
Operations