Skip to content
/Reference 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

Person accounts

Operations

Business accounts

Operations

Reference accounts

Operations

Index reference accounts for a business

Request

Returns an array containing all reference accounts associated with the business account specified in the request URL.

Path
business_idstringrequired
account_idstringrequired
Query
page[number]integer

The number of results pages to return.

page[size]integer

The number of results to return in each page.

filter[iban]string

Filter the results by IBAN.

filter[status]string

Filter the results by account status.

Enum"ACTIVE""INACTIVE"
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

Unique ID of the reference account.

Example: "ee4cc80bee604de09d036d8b7a9b6cb0"
statusstring

Current status of the reference account.

Example: "ACTIVE"
namestring

The reference account holder's name.

Example: "Max Mustermann"
ibanstring

The reference account's IBAN.

Example: "DE32110101001000000029"
mandate_numberstring

The number of the SDD mandate associated with the reference account.

Example: "example-mandate-number"
mandate_signature_datestring(date)

The date when the customer signed the SDD mandate.

Example: "2020-01-08"
mandate_typestring

The type of SDD mandate.

Enum"B2B""Core"
Example: "Core"
]
Response
application/json
[
  {
    "id": "ee4cc80bee604de09d036d8b7a9b6cb0",
    "status": "ACTIVE",
    "name": "Max Mustermann",
    "iban": "DE32110101001000000029",
    "mandate_number": "example-mandate-number",
    "mandate_signature_date": "2020-01-08",
    "mandate_type": "Core"
  }
]

Create a reference account for a business

Request

Adds an external bank account as a reference account to the business' Solaris account specified in the request URL.
Note: Before calling this endpoint, you must create a SEPA Direct Debit mandate and have the customer sign it.

Path
business_idstringrequired
account_idstringrequired
Bodyapplication/json

The content of the request.

namestring

The name of the external account holder.

Example: "account_holder_unique_ref"
ibanstring

IBAN of the reference account.

Example: "DE32110101001000000029"
mandate_numberstring

The identifier of the SDD mandate that the customer signed.

Example: "example-mandate-number"
mandate_signature_datestring(date)

The date when the customer signed the SDD mandate.

Example: "2020-01-08"
mandate_typestring

The type of SDD mandate.

Enum"B2B""Core"
Example: "Core"
application/json
{
  "name": "account_holder_unique_ref",
  "iban": "DE32110101001000000029",
  "mandate_number": "example-mandate-number",
  "mandate_signature_date": "2020-01-08",
  "mandate_type": "Core"
}

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the reference account.

Example: "ee4cc80bee604de09d036d8b7a9b6cb0"
statusstring

Current status of the reference account.

Example: "ACTIVE"
namestring

The reference account holder's name.

Example: "Max Mustermann"
ibanstring

The reference account's IBAN.

Example: "DE32110101001000000029"
mandate_numberstring

The number of the SDD mandate associated with the reference account.

Example: "example-mandate-number"
mandate_signature_datestring(date)

The date when the customer signed the SDD mandate.

Example: "2020-01-08"
mandate_typestring

The type of SDD mandate.

Enum"B2B""Core"
Example: "Core"
Response
application/json
{
  "id": "ee4cc80bee604de09d036d8b7a9b6cb0",
  "status": "ACTIVE",
  "name": "Max Mustermann",
  "iban": "DE32110101001000000029",
  "mandate_number": "example-mandate-number",
  "mandate_signature_date": "2020-01-08",
  "mandate_type": "Core"
}

Create reference account for a person

Request

Adds an external bank account as a reference account to the person's Solaris account specified in the request URL.
Note: Before calling this endpoint, you must create a SEPA Direct Debit mandate for your customer and have them sign it.

Path
person_idstringrequired
account_idstringrequired
Bodyapplication/json

The content of the request.

namestring

The name of the external account holder.

Example: "account_holder_unique_ref"
ibanstring

IBAN of the reference account.

Example: "DE32110101001000000029"
mandate_numberstring

The identifier of the SDD mandate that the customer signed.

Example: "example-mandate-number"
mandate_signature_datestring(date)

The date when the customer signed the SDD mandate.

Example: "2020-01-08"
application/json
{
  "name": "account_holder_unique_ref",
  "iban": "DE32110101001000000029",
  "mandate_number": "example-mandate-number",
  "mandate_signature_date": "2020-01-08"
}

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the reference account.

Example: "ee4cc80bee604de09d036d8b7a9b6cb0"
statusstring

Current status of the reference account.

Example: "ACTIVE"
namestring

The reference account holder's name.

Example: "Max Mustermann"
ibanstring

The reference account's IBAN.

Example: "DE32110101001000000029"
mandate_numberstring

The number of the SDD mandate associated with the reference account.

Example: "example-mandate-number"
mandate_signature_datestring(date)

The date when the customer signed the SDD mandate.

Example: "2020-01-08"
Response
application/json
{
  "id": "ee4cc80bee604de09d036d8b7a9b6cb0",
  "status": "ACTIVE",
  "name": "Max Mustermann",
  "iban": "DE32110101001000000029",
  "mandate_number": "example-mandate-number",
  "mandate_signature_date": "2020-01-08"
}

Index reference accounts for a person

Request

Returns an array containing all reference accounts associated with the person's Solaris account specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
Query
page[number]integer

The number of results pages to return.

page[size]integer

The number of results to return in each page.

filter[iban]string

Filter the results by IBAN.

filter[status]string

Filter the results by account status.

Enum"ACTIVE""INACTIVE"
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

Unique ID of the reference account.

Example: "ee4cc80bee604de09d036d8b7a9b6cb0"
statusstring

Current status of the reference account.

Example: "ACTIVE"
namestring

The reference account holder's name.

Example: "Max Mustermann"
ibanstring

The reference account's IBAN.

Example: "DE32110101001000000029"
mandate_numberstring

The number of the SDD mandate associated with the reference account.

Example: "example-mandate-number"
mandate_signature_datestring(date)

The date when the customer signed the SDD mandate.

Example: "2020-01-08"
]
Response
application/json
[
  {
    "id": "ee4cc80bee604de09d036d8b7a9b6cb0",
    "status": "ACTIVE",
    "name": "Max Mustermann",
    "iban": "DE32110101001000000029",
    "mandate_number": "example-mandate-number",
    "mandate_signature_date": "2020-01-08"
  }
]

Index rejected incoming transactions

Request

Returns an array containing all incoming transactions to the account specified in the request URL that Solaris rejected/returned.

Path
account_idstringrequired
Query
page[number]integer>= 1

The number of results pages to return.

Default 1
page[size]integer

The size of each page of results.

Default 10
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

ID of the rejected transaction.

Example: "95d06bc4e448af0d78259549964e4b4bsddm"
sender_namestring

The name of the person who sent the funds.

Example: "John Mustermann"
sender_ibanstring

IBAN of the account from which the funds were sent.

Example: "DE32110101001000000029"
amountobject

The amount of the transaction.

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

The reason why Solaris rejected the transaction.

Example: "Transaction sender name and account debtor name do not match."
rejected_atstring

UTC timestamp from when Solaris rejected the transaction.

Example: "2022-08-18T08:36:55Z"
]
Response
application/json
[
  {
    "id": "95d06bc4e448af0d78259549964e4b4bsddm",
    "sender_name": "John Mustermann",
    "sender_iban": "DE32110101001000000029",
    "amount": { … },
    "rejection_reason": "Transaction sender name and account debtor name do not match.",
    "rejected_at": "2022-08-18T08:36:55Z"
  }
]

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