Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/account-creation/

Operations
Operations
Operations

Request

Returns the business account specified in the request URL.

Path
business_idstringrequired
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"
purposestring

purpose of account

currencystring

currency of account

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

opened_atstring

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

Example: "2017-10-11T22:33:26Z"
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"
statusstring
closure_reasonstring

The reason for the account closure.

Enum"ACCOUNT_REVOCATION""ACCOUNT_REVOCATION_INTERNAL""COMPLIANCE_IMMEDIATE_INTERNAL""COMPLIANCE_ORDINARY_INTERNAL""CUSTOMER_WISH""CUSTOMER_WISH_INTERNAL""DUNNING_DECOUPLED_CARD_INTERNAL""INSOLVENCY_IMMEDIATE_INTERNAL""INSOLVENCY_ORDINARY_INTERNAL""PARTNER_SERVICE_ACCOUNT_TERMINATED"
Example: "COMPLIANCE_IMMEDIATE_INTERNAL"
overdraftobject(overdraft-2)
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", "purpose": "string", "currency": "EUR", "balance": { "value": 99000, "unit": "cents", "currency": "EUR" }, "available_balance": { "value": 89000, "unit": "cents", "currency": "EUR" }, "opened_at": "2017-10-11T22:33:26Z", "locking_status": "NO_BLOCK", "locking_reasons": [ "AML_FOLLOW_UP_OVERDUE" ], "account_limit": { "value": 100000, "unit": "cents", "currency": "EUR" }, "person_id": "bb66a0161a0a4066abfe133412f6236dcper", "business_id": "a9a25dc10aa74244bd0bb75d1ce6b3b5cbiz", "status": "string", "closure_reason": "COMPLIANCE_IMMEDIATE_INTERNAL", "overdraft": { "rate": 12.5, "limit": 10000 }, "closed_at": "2022-01-01T12:11:16Z" }

Create an account for a businessDeprecated

Request

Creates a bank account for the business specified in the request URL. The customer who opens the account is the account owner.
Please note the following:

  • An account can only be opened after the account owner has had a successful person identification.
  • Choose the BIC that corresponds with your desired passporting/branching scheme (e.g., SOBKDEB2XXX for German accounts, SOBKITM2XXX for Italian branch accounts).
  • On sandbox, set the account type to CHECKING_BUSINESS. Solaris' backend will automatically set the balance to 1000 EUR for testing purposes.

Path
business_idstringrequired
Bodyapplication/json

The content of the request.

typestring(Solaris-Decorators-AccountTypeEnum)

The type of account.

Enum"BASIC_ACCOUNT""BILLING_ACCOUNT""CALL_MONEY""CASH_DEPOSIT""CHECKING_BUSINESS""CHECKING_BUSINESS_CREDITLINE""CHECKING_FIXED_MATURITY""CHECKING_OVERDRAFT""CHECKING_OVERDRAFT_FLEXIBLE""CHECKING_PERSON_CREDIT_LINE"
purposestring

The purpose of the account. The default value is primary.

Example: "primary"
bicstring

The BIC to apply to the account. Choose the BIC that applies to the country where you wish to open the account.

Enum"SOBKDEBBXXX""SOBKDEB2XXX""SOBKITM2XXX""SOBKFRP2XXX""SOBKESM2XXX"
Example: "SOBKDEB2XXX"
application/json
{ "type": "CHECKING_BUSINESS", "purpose": "primary", "bic": "SOBKDEB2XXX" }

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the account.

Example: "efe320cbe121418c982b6af45bc9cacc"
ibanstring

The account's IBAN.

Example: "DE43110101005555555555"
bicstring

The account's BIC.

Example: "SOBKDEB2XXX"
typestring(Solaris-Decorators-AccountTypeEnum)

The type of account.

Enum"BASIC_ACCOUNT""BILLING_ACCOUNT""CALL_MONEY""CASH_DEPOSIT""CHECKING_BUSINESS""CHECKING_BUSINESS_CREDITLINE""CHECKING_FIXED_MATURITY""CHECKING_OVERDRAFT""CHECKING_OVERDRAFT_FLEXIBLE""CHECKING_PERSON_CREDIT_LINE"
purposestring

The purpose of the account.

Example: "primary"
currencystring

The currency of the account.

Example: "EUR"
balanceobject

The funds that the customer currently has on their account. Includes bookings with a valuta date no later than the current date.

available_balanceobject

The funds that the customer has at their disposal. This includes bookings (positive bookings with a valuta date up to the current date, negative bookings regardless of valuta date) and is corrected on reservations and the account limit.

locking_statusstring

Indicates whether the account is currently locked.

Enum"NO_BLOCK""BLOCK""CREDIT_BLOCK""DEBIT_BLOCK"
Example: "NO_BLOCK"
locking_reasonsArray of strings

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"
Example: [null]
account_limitobject

The allowed level of negative balance on the account. This value is factored into the calculation of the account's available_balance.

person_idstring

Person ID of the account owner.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
business_idstring

ID of the business to which the account belongs (if applicable).

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
Response
application/json
{ "id": "efe320cbe121418c982b6af45bc9cacc", "iban": "DE43110101005555555555", "bic": "SOBKDEB2XXX", "type": "BASIC_ACCOUNT", "purpose": "primary", "currency": "EUR", "balance": { "value": 1000, "unit": "cents", "currency": "EUR" }, "available_balance": { "value": 1000, "unit": "cents", "currency": "EUR" }, "locking_status": "NO_BLOCK", "locking_reasons": [ null ], "account_limit": { "value": 1000, "unit": "cents", "currency": "EUR" }, "person_id": "0ba2211cab11af6094d60ead81f2bd9dcper", "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz" }