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

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

Map a person's main account to a savings account

Request

Maps a person's savings account to their main (checking) account and then triggers the remaining steps for savings account onboarding. The person may only transfer money to and from their savings account using the main account mapped by this request.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

The request body.

main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
deposit_typestring(DepositTypes)required

The account type.

Value"SAVINGS_ACCOUNT"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
application/json
{
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "deposit_type": "SAVINGS_ACCOUNT",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1"
}

Responses

The mapping was successfully created, and the savings account onboarding process has started.

Bodyapplication/json
idstringrequired

ID of the mapping between the main account and the savings account.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
deposit_typestring(DepositTypes)required

The account type.

Value"SAVINGS_ACCOUNT"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
statusstring(DepositStatus)

The current status of the savings account.

Enum"OPENED""TAX_REGISTERED""ACTIVE""INACTIVE""FAILED"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "status": "OPENED",
  "deposit_type": "SAVINGS_ACCOUNT",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1"
}

Map a business' main account to a savings account

Request

Maps a business' savings account to its main (checking) account and then triggers the remaining steps for savings account onboarding. The business may only transfer money to and from their savings account using the main account mapped by this request.

Path
business_idstringrequired

Unique ID of a business.

Example: 990bbac68a34add190786b9c74f4c82fcbiz
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

The request payload.

main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
deposit_typestring(DepositTypes)required

The account type.

Value"SAVINGS_ACCOUNT"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
application/json
{
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "deposit_type": "SAVINGS_ACCOUNT",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1"
}

Responses

The mapping was successfully created, and the savings account onboarding process has started.

Bodyapplication/json
idstringrequired

ID of the mapping between the main account and the savings account.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
deposit_typestring(DepositTypes)required

The account type.

Value"SAVINGS_ACCOUNT"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
statusstring(DepositStatus)

The current status of the savings account.

Enum"OPENED""TAX_REGISTERED""ACTIVE""INACTIVE""FAILED"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "status": "OPENED",
  "deposit_type": "SAVINGS_ACCOUNT",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1"
}

Create pay-in to a person's savings account

Request

Transfers money from a person's main account to their savings account.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

The request body.

main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount to pay in to the savings account.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money into Deposit Account"
application/json
{
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money into Deposit Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Responses

The transaction has been executed.

Bodyapplication/json
idstringrequired

Transaction ID of the pay-in request.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount of the transaction.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money from Deposit Account to Main Account"
created_atstring(date-time)

UTC timestamp from when the transaction was requested.

Example: "2023-10-10T16:02:54Z"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money from Deposit Account to Main Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "created_at": "2023-10-10T16:02:54Z"
}

Create pay-in to a business' savings account

Request

Transfers money from a business' main account to its savings account.

Path
business_idstringrequired

Unique ID of a business.

Example: 990bbac68a34add190786b9c74f4c82fcbiz
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

The request body.

main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount to pay in to the savings account.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money into Deposit Account"
application/json
{
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money into Deposit Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Responses

The transaction has been executed.

Bodyapplication/json
idstringrequired

Transaction ID of the pay-in request.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount of the transaction.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money from Deposit Account to Main Account"
created_atstring(date-time)

UTC timestamp from when the transaction was requested.

Example: "2023-10-10T16:02:54Z"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money from Deposit Account to Main Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "created_at": "2023-10-10T16:02:54Z"
}

Create payout from a person's savings account

Request

Transfers money from a person's savings account to their main account.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

The request body.

main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount to pay out to the main account.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money from Deposit Account to Main Account"
application/json
{
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money from Deposit Account to Main Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Responses

The transaction has been executed.

Bodyapplication/json
idstringrequired

Transaction ID of the payout request.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount of the transaction.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money from Deposit Account to Main Account"
created_atstring(date-time)

UTC timestamp from when the transaction was requested.

Example: "2023-10-10T16:02:54Z"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money from Deposit Account to Main Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "created_at": "2023-10-10T16:02:54Z"
}

Create payout from a business' savings account

Request

Transfers money from a business' savings account to its main account.

Path
business_idstringrequired

Unique ID of a business.

Example: 990bbac68a34add190786b9c74f4c82fcbiz
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

The request body.

main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount to pay out to the main account.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money from Deposit Account to Main Account"
application/json
{
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money from Deposit Account to Main Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Responses

The transaction has been executed.

Bodyapplication/json
idstringrequired

Transaction ID of the payout request.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
main_account_idstring(MainAccount)required

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount of the transaction.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
descriptionstring

Optional note about the transaction.

Example: "Transfer money from Deposit Account to Main Account"
created_atstring(date-time)

UTC timestamp from when the transaction was requested.

Example: "2023-10-10T16:02:54Z"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "description": "Transfer money from Deposit Account to Main Account",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "created_at": "2023-10-10T16:02:54Z"
}

Create tax exemption order for a person

Request

Creates a tax exemption order for a person's savings account, specified in the request URL by its ID. Specify the amount to be exempted from tax in the request body.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

Tax Exemption Request payload.

referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount to be exempted from tax.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
valid_from_yearstring(ValidFromYear)required

Year from which the tax exemption order takes effect.

Example: "2023"
valid_to_yearstring(ValidToYear)

Year until which the tax exemption order applies.

Example: "2025"
application/json
{
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "valid_from_year": "2023",
  "valid_to_year": "2025"
}

Responses

The request for a tax exemption order has been submitted for processing.

Bodyapplication/json
idstringrequired

ID of the tax exemption order.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
referencestring(uuid)(Reference)required

UUID to use as an idempotency reference for the transaction.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
amountobjectrequired

The amount to be exempted from tax.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
valid_from_yearstring(ValidFromYear)required

Year from which the tax exemption order takes effect.

Example: "2023"
valid_to_yearstring(ValidToYear)

Year until which the tax exemption order applies.

Example: "2025"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "valid_from_year": "2023",
  "valid_to_year": "2025"
}

Update a person's tax exemption order

Request

Modifies the time period and/or tax-exempt amount of a person's tax exemption order.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Bodyapplication/jsonrequired

The request payload.

amountobject

The amount to be exempted from tax.

valid_from_yearstring(ValidFromYear)

Year from which the tax exemption order takes effect.

Example: "2023"
valid_to_yearstring(ValidToYear)

Year until which the tax exemption order applies.

Example: "2025"
application/json
{
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "valid_from_year": "2023",
  "valid_to_year": "2025"
}

Responses

The request to update the tax exemption order has been submitted for processing.

Bodyapplication/json
idstringrequired

ID of the tax exemption order.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
amountobjectrequired

The amount to be exempted from tax.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
valid_from_yearstring(ValidFromYear)required

Year from which the tax exemption order takes effect.

Example: "2023"
valid_to_yearstring(ValidToYear)

Year until which the tax exemption order applies.

Example: "2025"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "valid_from_year": "2023",
  "valid_to_year": "2025"
}

Retrieve a person's tax exemption order

Request

Returns the tax exemption order for the person specified in the request URL.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
No request payload

Responses

The request was successful.

Bodyapplication/json
idstringrequired

ID of the tax exemption order.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
amountobjectrequired

The amount to be exempted from tax.

amount.​valueinteger

The amount.

Example: 5000
amount.​unitstring

Money unit used to represent the amount.

Example: "cents"
amount.​currencystring

The currency in which the amount is represented.

Example: "EUR"
valid_from_yearstring(ValidFromYear)required

Year from which the tax exemption order takes effect.

Example: "2023"
statusstringrequired

The current status of the tax exemption order.

Enum"ACTIVE""INACTIVE""DELETED""EXPIRED""INVALID"
Example: "ACTIVE"
valid_to_yearstring(ValidToYear)

Year until which the tax exemption order applies.

Example: "2025"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "valid_from_year": "2023",
  "valid_to_year": "2025",
  "status": "ACTIVE"
}

Remove a person's tax exemption order

Request

Deletes the tax exemption order for the person specified in the request URL.
Note that you should only use this endpoint for erroneous or wrongly submitted tax exemption orders that were not utilized. Please use PATCH Close a person's tax exemption order to close previously utilized tax exemption orders.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
No request payload

Responses

The request to delete the tax exemption order was successfully submitted.

Headers
Locationstring
Bodyapplication/json
idstringrequired

ID of the tax exemption order.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8"
}

Close a person's tax exemption order

Request

Closes the tax exemption order for the person specified in the request URL.
Note that you should only use this endpoint for previously utilized tax exemption orders. To delete erroneous or wrongly submitted tax exemption orders that were not utilized, please use DELETE Remove a person's tax exemption order.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
No request payload

Responses

The request to close the person's tax exemption order was successfully submitted.

Bodyapplication/json
idstringrequired

ID of the tax exemption order.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8"
}

Request the utilization details of a person's tax exemption order

Request

Submits a request to retrieve the tax exemption utilization details for the person and the savings account specified in the request URL. This endpoint will return a response body with only the ID of the request. The utilization details will be sent asynchronously via the 'TAX_EXEMPTION_UTILIZATION' webhook event after the request is successfully processed.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
No request payload

Responses

The request to fetch the person's tax exemption order utilization was successfully submitted.

Bodyapplication/json
idstringrequired

The ID of the request to retrieve the tax exemption utilization details.

Example: "d222a0b8-07ea-49be-83c1-68719be286e8"
Response
application/json
{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8"
}

Get interest details for a person's savings account

Request

Returns the interest details for a person's savings account, specified in the request URL by its ID. The response includes the interest rate, the amount of interest accrued, and the date when the interest calculator was last run for the account.

Path
person_idstringrequired

Unique ID of a person.

Example: 111110faed3c03261a08e2660c0c08bdcper
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
No request payload

Responses

Interest details have been fetched successfully.

Bodyapplication/json
interest_ratenumberrequired

The interest rate that applies to the savings account.

Example: 10.5
accrued_interestobject(MoneyAmount)required
accrued_interest.​valueinteger(int64)
Example: 1400
accrued_interest.​currencystring
Value"EUR"
accrued_interest.​unitstring
Value"cents"
Example: "cents"
last_valuta_datestring

Date (valuta_date) on which the interest calculator was last run for the savings account.

Example: "2024-07-22"
Response
application/json
{
  "interest_rate": 10.5,
  "accrued_interest": {
    "value": 1400,
    "currency": "EUR",
    "unit": "cents"
  },
  "last_valuta_date": "2024-07-22"
}

Get interest details for a business' savings account

Request

Returns the interest details for a business' savings account, specified in the request URL by its ID. The response includes the interest rate, the amount of interest accrued, and the date when the interest calculator was last run for the account.

Path
business_idstringrequired

Unique ID of a business.

Example: 990bbac68a34add190786b9c74f4c82fcbiz
account_idstringrequired

Unique ID of a Solaris account.

Example: e48c29b85992b8772eb7ddd518490920cacc
No request payload

Responses

Interest details have been fetched successfully.

Bodyapplication/json
interest_ratenumberrequired

The interest rate that applies to the savings account.

Example: 10.5
accrued_interestobject(MoneyAmount)required
accrued_interest.​valueinteger(int64)
Example: 1400
accrued_interest.​currencystring
Value"EUR"
accrued_interest.​unitstring
Value"cents"
Example: "cents"
last_valuta_datestring

Date (valuta_date) on which the interest calculator was last run for the savings account.

Example: "2024-07-22"
Response
application/json
{
  "interest_rate": 10.5,
  "accrued_interest": {
    "value": 1400,
    "currency": "EUR",
    "unit": "cents"
  },
  "last_valuta_date": "2024-07-22"
}