Skip to content
/Person accounts

Account creation (1.0)

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

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

Account opening

Operations

Person accounts

Operations

Index a person's accounts

Request

Returns an array containing all accounts owned by the person specified in the request URL.

Path
person_idstringrequired
Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

filter[iban]string

Filters the results by IBAN.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

The ID of the account.

Example: "efdd8c5e7ec0b4e36768c6de39e6cfc0cacc"
ibanstring

The account's IBAN.

Example: "DE05011010100000000043"
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"
opened_atstring

UTC timestamp from when the account was opened.

Example: "2020-04-25T12:50:33Z"
statusstring

Current status of the account

Example: "ACTIVE"
locking_statusstring

Indicates whether or not funds can be transferred to or from the account.

Enum"BLOCK""CREDIT_BLOCK""DEBIT_BLOCK""NO_BLOCK"
Example: "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

Person ID of the account owner.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
business_idstring

ID of the business that owns the account (if applicable).

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
overdraftobject(overdraft)

Object describing an overdraft on the account.

]
Response
application/json
[
  {
    "id": "efdd8c5e7ec0b4e36768c6de39e6cfc0cacc",
    "iban": "DE05011010100000000043",
    "bic": "SOBKDEB2XXX",
    "type": "BASIC_ACCOUNT",
    "purpose": "primary",
    "opened_at": "2020-04-25T12:50:33Z",
    "status": "ACTIVE",
    "locking_status": "BLOCK",
    "locking_reasons": [ … ],
    "person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "overdraft": { … }
  }
]

Get a single personal account

Request

Returns information about a single personal banking account.

Path
person_idstringrequired
account_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-2)
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"
}

Update a personal account

Request

Updates the personal account specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
Bodyapplication/jsonrequired
block_reasonsArray of stringsrequired

The reason the customer wants to block/unblock their account.

Items Enum"CUSTOMER_WISH""COMPLIANCE_PARTNER"
Example: ["CUSTOMER_WISH"]
person_idstringrequired

The customer's unique person ID.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
acccount_idstring

The account ID.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
commentstring

Additional information about the request.

application/json
{
  "block_reasons": [
    "CUSTOMER_WISH"
  ],
  "acccount_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "comment": "string"
}

Responses

Successfully updated the person's account.

Response
No content

Create an account for a personDeprecated

Request

Creates an account for the person specified in the request URL.
The person in the request URL will be assigned the role of account owner. Consult with your Partner Manager to determine which values you should use for account_type.
Note that you may only open an account for a person after they have successfully completed the identification process.
Upon creation, the account_limit will always be set to zero. If you are creating a specific type of account with a default limit in place as agreed with Solaris, then use the GET Retrieve an account endpoint to obtain this value.

Path
person_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. Use primary unless otherwise instructed.

Default "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: "SOBKDEBBXXX"
application/json
{
  "type": "CHECKING_BUSINESS",
  "purpose": "primary",
  "bic": "SOBKDEBBXXX"
}

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

Business accounts

Operations