Skip to content
Account Management
/
/
Index accounts

Account management (1.0)

Download OpenAPI description
account-management.json
account-management.yaml
Languages
Servers
Mock Server

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

Accounts

Operations

Index accounts

Request

Returns all accounts (both personal & business) managed under a partner.

Query
page[number]string

Returns a specific page of results.

page[size];integer[ 1 .. 200 ]

Determines the size of each page of results.The maximum value is 200

filter[type]string

Filters the returned accounts by type.

filter[iban]string

Filters the returned accounts by IBAN.

filter[id]string

Filters the returned accounts by ID

No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

ID of the account.

Example: "5526853938474f3e92b22a03ea57a544cacc"
ibanstring

IBAN associated with the account.

Example: "DE76110101001100000999"
bicstring

BIC associated with the account.

Example: "SOBKDEBBXXX"
typestring

Type of the account.

Enum"CHECKING_PERSONAL""CHECKING_BUSINESS"
Example: "CHECKING_PERSONAL"
locking_statusstring

Read-only booking block indicating whether funds can be transferred to/from the account. The default status is NO_BLOCK. Other status values indicate that funds may neither be credited to, nor debited from, the account. Only authorized Solaris employees can change the status of this value. Attempting to perform an action not compliant with the current blocking status (e.g., initiating a transaction to or from a blocked account) will cause either a return of the transaction or an exception.

Enum"NO_BLOCK""CREDIT_BLOCK""DEBIT_BLOCK""BLOCK"
locking_reasonsArray of strings(Solaris-Enums-LockingReason)

Read-only indicator of the reason a block was applied to the account. If the account is not blocked, then this value will contain an empty array.

Items Enum"AML_FOLLOW_UP_OVERDUE""COMPANY_FOUNDATION""COMPLIANCE""CUSTOMER_WISH""DECOUPLED_CARD_DUNNING""DECOUPLED_CARD_TERMINATION""IDENTIFICATION_FAILED""IDENTIFICATION_DOCUMENT_EXPIRED""IN_CLOSURE""INSOLVENCY"
person_idstring

ID of the person for whom the account was created.

Example: "bb66a0161a0a4066abfe133412f6236dcper"
business_idstring

ID of the business for whom the account was created. Only filled if the account owner is a legal entity.

Example: "a9a25dc10aa74244bd0bb75d1ce6b3b5cbiz"
overdraftobject(overdraft)
]
Response
application/json
[
  {
    "id": "5526853938474f3e92b22a03ea57a544cacc",
    "iban": "DE76110101001100000999",
    "bic": "SOBKDEBBXXX",
    "type": "CHECKING_PERSONAL",
    "locking_status": "NO_BLOCK",
    "locking_reasons": [ … ],
    "person_id": "bb66a0161a0a4066abfe133412f6236dcper",
    "business_id": "a9a25dc10aa74244bd0bb75d1ce6b3b5cbiz",
    "overdraft": { … }
  }
]

Get an account

Request

Returns information about a specific account (personal or business).

Path
idstringrequired
No request payload

Responses

The operation was successful.

Bodyapplication/json
idstring

ID of the account.

Example: "5526853938474f3e92b22a03ea57a544cacc"
ibanstring

IBAN associated with the account.

Example: "DE76110101001100000999"
bicstring

BIC associated with the account.

Example: "SOBKDEBBXXX"
typestring

Type of the account.

Enum"CHECKING_PERSONAL""CHECKING_BUSINESS"
Example: "CHECKING_PERSONAL"
overdraftobject(overdraft)
balanceobject

The current account balance. Value is in Euro cents.

available_balanceobject

The current account balance including reservations that have not yet been booked. Value is in Euro cents.

locking_statusstring

Read-only booking block indicating whether funds can be transferred to/from the account. The default status is NO_BLOCK. Other status values indicate that funds may neither be credited to, nor debited from, the account. Only authorized Solaris employees can change the status of this value. Attempting to perform an action not compliant with the current blocking status (e.g., initiating a transaction to or from a blocked account) will cause either a return of the transaction or an exception.

Enum"NO_BLOCK""CREDIT_BLOCK""DEBIT_BLOCK""BLOCK"
locking_reasonsArray of strings(Solaris-Enums-LockingReason)

Read-only indicator of the reason a block was applied to the account. If the account is not blocked, then this value will contain an empty array.

Items Enum"AML_FOLLOW_UP_OVERDUE""COMPANY_FOUNDATION""COMPLIANCE""CUSTOMER_WISH""DECOUPLED_CARD_DUNNING""DECOUPLED_CARD_TERMINATION""IDENTIFICATION_FAILED""IDENTIFICATION_DOCUMENT_EXPIRED""IN_CLOSURE""INSOLVENCY"
account_limitobject

The allowed amount of negative balance on the account. This is included into the calculation of the available_balance.

person_idstring

ID of the person for whom the account was created.

Example: "bb66a0161a0a4066abfe133412f6236dcper"
business_idstring

ID of the business for whom the account was created. Only filled if the account owner is a legal entity.

Example: "a9a25dc10aa74244bd0bb75d1ce6b3b5cbiz"
partner_idstring

ID of the Solaris partner with whom the account is associated.

Example: "55e47118b78741dbb81cdd3d372bc448cpar"
opened_atstring

Date and time when the account was opened (UTC format).

Example: "2017-10-11T22:33:26Z"
statusstring

Status of the account.

Enum"ACTIVE""INACTIVE"
Example: "ACTIVE"
closed_atstring

Date and time when the account was closed (UTC format).

Example: "2022-01-01T12:11:16Z"
Response
application/json
{
  "id": "5526853938474f3e92b22a03ea57a544cacc",
  "iban": "DE76110101001100000999",
  "bic": "SOBKDEBBXXX",
  "type": "CHECKING_PERSONAL",
  "overdraft": {
    "rate": 12.5,
    "limit": 10000
  },
  "balance": {
    "value": 99000,
    "unit": "cents",
    "currency": "EUR"
  },
  "available_balance": {
    "value": 89000,
    "unit": "cents",
    "currency": "EUR"
  },
  "locking_status": "NO_BLOCK",
  "locking_reasons": [
    "AML_FOLLOW_UP_OVERDUE"
  ],
  "account_limit": {
    "value": 100000,
    "unit": "cents",
    "currency": "EUR"
  },
  "person_id": "bb66a0161a0a4066abfe133412f6236dcper",
  "business_id": "a9a25dc10aa74244bd0bb75d1ce6b3b5cbiz",
  "partner_id": "55e47118b78741dbb81cdd3d372bc448cpar",
  "opened_at": "2017-10-11T22:33:26Z",
  "status": "ACTIVE",
  "closed_at": "2022-01-01T12:11:16Z"
}

Get balance for an account

Request

Returns the balance of an account in the form of two objects—balance and available_balance.

Path
account_idstringrequired
No request payload

Responses

The operation was successful.

Bodyapplication/json
available_balanceobject

The amount of funds that a customer currently has on their account minus any funds that are held in reservations (i.e., the amount of money the customer currently has at their disposal) including the account limit.

balanceobject

The amount of funds that a customer currently has on their account. This object only includes posted bookings (i.e., bookings with an elapsed valuta_date).

seizure_protectionobject(seizure_protection)

(For seizure protected accounts only) An object that describes the current Seizure Protection state of the account. It includes the amount of funds on the account that has been blocked by a seizure and the amount that is seizure-protected.

Response
application/json
{
  "available_balance": {
    "value": 89000,
    "unit": "cents",
    "currency": "EUR"
  },
  "balance": {
    "value": 99000,
    "unit": "cents",
    "currency": "EUR"
  },
  "seizure_protection": {
    "current_blocked_amount": { … },
    "protected_amount": { … },
    "protected_amount_expiring": { … },
    "protected_amount_expiring_date": "2022-07-31"
  }
}

Get average daily balance for an account

Request

Fetches the average of daily end-of-day balance for the specified account and date range. A maximum of one year can be provided as date range. If the account has no balance for a given day because for example it was opened after the start_date OR closed before end_date, those days will have end-of-day balance as 0. If end_date is in the future, those days' balance is equal to the latest balance. It is recommended to present the average balance to the Customer as Yearly for past years and Year to Date for current year.

Path
account_idstringrequired

Unique identifier to an account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Query
start_datestring(date)([0-9]{4})-(?:[0-9]{2})-([0-9]{2})required

Starting date (inclusive) for balance calculation

Example: start_date=2020-01-31
end_datestring(date)([0-9]{4})-(?:[0-9]{2})-([0-9]{2})required

End date (inclusive) for balance calculation

Example: end_date=2020-12-31
No request payload

Responses

Average daily balance successfully calculated.

Bodyapplication/json
acccount_idstring
Example: "e48c29b85992b8772eb7ddd518490920cacc"
average_daily_balanceobject(money)
Response
application/json
{
  "acccount_id": "e48c29b85992b8772eb7ddd518490920cacc",
  "average_daily_balance": {
    "value": 2000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Get account bookings

Request

Returns an array containing all bookings for an account.

Path
account_idstringrequired
Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

sortstring

Sort the results by booking_date, valuta_date, recorded_at, or id.

Enum"booking_date""valuta_date""recorded_at""id"
filter[id]string

ID of the booking.

filter[recorded_at][min]string

Filter the results by the date and time when the booking was recorded starting from a certain date and time.

filter[recorded_at][max]string

Filter the results by the date and time when the booking was recorded up until a certain date and time.

filter[valuta_date]string

Filter the results by the valuta date.

filter[booking_type]string

Filter the results by booking type.

filter[description]string

Filter the results by booking description.

filter[receiver_iban_virtual]string

Filter the results to show bookings received on virtual IBANs.

filter[transaction_id]string

Filter the results by transaction ID.

No request payload

Responses

The operation was successful.

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"
}

Person accounts

Operations

Business accounts

Operations

Reference accounts

Operations

Account closure requests

Operations

Fee collection

Operations

Reservations

Operations

Seizures

Operations

Bank statements

Operations

Statements of account

Operations

Fee summary statements

Operations

Person messages

Operations

Business messages

Operations

Trusted IBANs

Operations

Virtual IBANs

Operations

IBAN validation

Operations

Savings Accounts

Operations