Skip to content
/Person messages

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

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

Index messages for a person's account

Request

Returns an array containing all messages sent to the person specified in the request URL regarding the given account.

Path
person_idstringrequired
account_idstringrequired
Query
page[size]integer

Specifies the number of entries to include in each results page.

Default 10
page[number]integer

Specifies the number of results pages to return.

Default 1
No request payload

Responses

Successful result of the operation.

Headers
Totalstring

Total number of entries to return in the response.

Example: "123"
Per-Pagestring

Number of entries to return per page.

Example: "10"
Linkstring

Specifies links to other pages.

Example: "<url?page[size]=10&page[number]=1>; rel=\"first\", <url?page[size]=10&page[number]=13>; rel=\"last\", <url?page[size]=10&page[number]=2>; rel=\"next\", <url?page[size]=10&page[number]=4>; rel=\"prev\"\n"
Bodyapplication/jsonArray [
idstring

ID of the message.

Example: "f4ed772c970e1096a73d9418192a2d0camsg"
account_idstring

ID of the account for which the message was sent.

Example: "c2a13abed3b0686ab5343aa748d7f2fecacc"
titlestring

The title of the message.

Example: "Ihre Samsung Pay Bezahlung"
textstring

The text of the message.

required_notification_channelstring

The notification channel used to send the message.

Enum"any""email"
created_atstring(date-time)

UTC timestamp from when the message was created.

Example: "2022-06-20T19:02:49Z"
]
Response
application/json
[
  {
    "id": "f4ed772c970e1096a73d9418192a2d0camsg",
    "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
    "title": "Ihre Samsung Pay Bezahlung",
    "text": "string",
    "required_notification_channel": "any",
    "created_at": "2022-06-20T19:02:49Z"
  }
]

Index messages for a person

Request

Returns an array containing all messages sent to the person specified in the request URL.

Path
person_idstringrequired
Query
page[size]integer

Specifies the number of entries to include in each results page.

Default 10
page[number]integer

Specifies the number of results pages to return.

Default 1
No request payload

Responses

Successful result of the operation.

Headers
Totalstring

Total number of entries to return in the response.

Example: "123"
Per-Pagestring

Number of entries to return per page.

Example: "10"
Linkstring

Specifies links to other pages.

Example: "<url?page[size]=10&page[number]=1>; rel=\"first\", <url?page[size]=10&page[number]=13>; rel=\"last\", <url?page[size]=10&page[number]=2>; rel=\"next\", <url?page[size]=10&page[number]=4>; rel=\"prev\"\n"
Bodyapplication/jsonArray [
idstring

ID of the message.

Example: "f4ed772c970e1096a73d9418192a2d0camsg"
account_idstring

ID of the account for which the message was sent.

Example: "c2a13abed3b0686ab5343aa748d7f2fecacc"
titlestring

The title of the message.

Example: "Ihre Samsung Pay Bezahlung"
textstring

The text of the message.

required_notification_channelstring

The notification channel used to send the message.

Enum"any""email"
created_atstring(date-time)

UTC timestamp from when the message was created.

Example: "2022-06-20T19:02:49Z"
]
Response
application/json
[
  {
    "id": "f4ed772c970e1096a73d9418192a2d0camsg",
    "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
    "title": "Ihre Samsung Pay Bezahlung",
    "text": "string",
    "required_notification_channel": "any",
    "created_at": "2022-06-20T19:02:49Z"
  }
]

Return a message for a person

Request

Returns a specific message for the person specified in the request URL.

Path
idstringrequired
person_idstringrequired
No request payload

Responses

Successful result of the operation.

Bodyapplication/json
idstring

ID of the message.

Example: "f4ed772c970e1096a73d9418192a2d0camsg"
account_idstring

ID of the account for which the message was sent.

Example: "c2a13abed3b0686ab5343aa748d7f2fecacc"
titlestring

The title of the message.

Example: "Ihre Samsung Pay Bezahlung"
textstring

The text of the message.

required_notification_channelstring

The notification channel used to send the message.

Enum"any""email"
created_atstring(date-time)

UTC timestamp from when the message was created.

Example: "2022-06-20T19:02:49Z"
Response
application/json
{
  "id": "f4ed772c970e1096a73d9418192a2d0camsg",
  "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  "title": "Ihre Samsung Pay Bezahlung",
  "text": "string",
  "required_notification_channel": "any",
  "created_at": "2022-06-20T19:02:49Z"
}

Retrieve a message for a person

Request

Returns a specific message for a person regarding the given account as specified in the request URL.

Path
idstringrequired
person_idstringrequired
account_idstringrequired
No request payload

Responses

Successful result of the operation.

Bodyapplication/json
idstring

ID of the message.

Example: "f4ed772c970e1096a73d9418192a2d0camsg"
account_idstring

ID of the account for which the message was sent.

Example: "c2a13abed3b0686ab5343aa748d7f2fecacc"
titlestring

The title of the message.

Example: "Ihre Samsung Pay Bezahlung"
textstring

The text of the message.

required_notification_channelstring

The notification channel used to send the message.

Enum"any""email"
created_atstring(date-time)

UTC timestamp from when the message was created.

Example: "2022-06-20T19:02:49Z"
Response
application/json
{
  "id": "f4ed772c970e1096a73d9418192a2d0camsg",
  "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  "title": "Ihre Samsung Pay Bezahlung",
  "text": "string",
  "required_notification_channel": "any",
  "created_at": "2022-06-20T19:02:49Z"
}

Business messages

Operations

Trusted IBANs

Operations

Virtual IBANs

Operations

IBAN validation

Operations

Savings Accounts

Operations