Savings Plans

Download Spec

All savings plans related paths.

Retrieve a savings plan

get /savings_plans/{savings_plan_id}

Retrieve a savings plan specified by its ID.

savings_plan_id

string

uuid

required

Response

ExamplesSchema

OK

{
  "id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
  "created_at": "2023-07-21T14:10:00.00Z",
  "updated_at": "2023-07-21T15:10:00.00Z",
  "user_id": "4b9732bd-7496-4913-8a5f-6360479d7fed",
  "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
  "name": "Instrument savings plan",
  "type": "INSTRUMENT",
  "instrument_id": "DE0007664005",
  "instrument_id_type": "ISIN",
  "cash_amount": "100.00",
  "currency": "EUR",
  "start_date": "2023-07-24",
  "period": "WEEK",
  "interval": 1,
  "status": "ACTIVE"
}

Delete a savings plan

delete /savings_plans/{savings_plan_id}

Delete a savings plan specified by its ID.

savings_plan_id

string

uuid

required

Response

ExamplesSchema

The request has been successfully accepted and will be processed asynchronously.

Empty response

List savings plans

get /savings_plans

List savings plans

account_id

string

Filters savings plans by account ID

Example
"3ada8e9e-82c4-4c78-a43d-a691b1636509"

user_id

string

Filters savings plans by user ID

Example
"996e5e2c-bb76-4a38-8d5c-ff43d86904da"

instrument_id

One Of

Filters savings plans by instrument ID (ISIN)

Example
"FR0010524777"

sort

string

Sort the result by id.

Default
"id"
Enum
  • id

order

string

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default
"ASC"
Enum
  • ASC

offset

int

i32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

Response

ExamplesSchema

OK

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
      "created_at": "2023-07-21T14:10:00.00Z",
      "updated_at": "2023-07-21T15:10:00.00Z",
      "user_id": "4b9732bd-7496-4913-8a5f-6360479d7fed",
      "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
      "name": "Instrument savings plan",
      "type": "INSTRUMENT",
      "instrument_id": "DE0007664005",
      "instrument_id_type": "ISIN",
      "cash_amount": "100.00",
      "currency": "EUR",
      "start_date": "2023-07-24",
      "period": "WEEK",
      "interval": 1,
      "status": "ACTIVE"
    }
  ]
}

Create savings plan

post /savings_plans

Create savings plan

user_id

string

uuid

required

User unique identifier.

account_id

string

uuid

required

Account unique identifier.

name

string

Savings plan name

type

string

required

Type of the Savings plan.

  • PORTFOLIO -
  • INSTRUMENT -
Enum
  • PORTFOLIO
  • INSTRUMENT

instrument_id

One Of

Instrument unique identifier.

instrument_id_type

string

The type of the ID used in the request.

  • ISIN - International Securities Identification Number
  • WKN - German securities identification code
Default
"ISIN"
Enum
  • ISIN
  • WKN

cash_amount

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

start_date

string

^[12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

required

First date of the savings plan execution in YYYY-MM-DD format.

period

string

required

Unit of time.

  • WEEK -
  • MONTH -
  • YEAR -
Enum
  • WEEK
  • MONTH
  • YEAR

interval

int

required

Number of periods between executions

Default
1
Min
1
Max
1000

Request

{
  "user_id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
  "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
  "name": "Instrument savings plan",
  "type": "INSTRUMENT",
  "instrument_id": "DE0007664005",
  "instrument_id_type": "ISIN",
  "cash_amount": "100.00",
  "currency": "EUR",
  "start_date": "2023-07-24",
  "period": "WEEK",
  "interval": 2
}

Response

ExamplesSchema

Savings plan object

{
  "id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
  "created_at": "2023-07-21T14:10:00.00Z",
  "updated_at": "2023-07-21T15:10:00.00Z",
  "user_id": "4b9732bd-7496-4913-8a5f-6360479d7fed",
  "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
  "name": "Instrument savings plan",
  "type": "INSTRUMENT",
  "instrument_id": "DE0007664005",
  "instrument_id_type": "ISIN",
  "cash_amount": "100.00",
  "currency": "EUR",
  "start_date": "2023-07-24",
  "period": "WEEK",
  "interval": 1,
  "status": "ACTIVE"
}

Retrieve savings plan execution

get /savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}

Retrieve savings plan execution

savings_plan_id

string

uuid

required

savings_plan_execution_id

string

uuid

required

Response

ExamplesSchema

OK

{
  "id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
  "created_at": "2023-07-21T14:10:00.00Z",
  "updated_at": "2023-07-21T15:10:00.00Z",
  "user_id": "4b9732bd-7496-4913-8a5f-6360479d7fed",
  "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
  "savings_plan_id": "c31083c1-1cd3-405f-95d1-f49a37f0e032",
  "order_id": "68068440-6b8e-4700-8cfc-95bf21b34b96",
  "cash_amount": "100",
  "currency": "EUR",
  "status": "FILLED",
  "type": "INSTRUMENT",
  "instrument_id": "IE00BYTRRD19",
  "instrument_id_type": "ISIN",
  "execution_date": "2023-07-24"
}

Delete savings plan execution

delete /savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}

Delete savings plan execution

savings_plan_id

string

uuid

required

savings_plan_execution_id

string

uuid

required

Response

ExamplesSchema

The request has been successfully accepted and will be processed asynchronously.

Empty response

List savings plan executions

get /savings_plans/{savings_plan_id}/executions

List savings plan executions for a saving plan specified by its ID.

start_date

string

Returns savings plan executions starting from and including this date (UTC)

Example
"2022-10-14T00:00:00Z"

end_date

string

Returns savings plan executions up to this date (UTC)

Example
"2022-10-14T00:00:00Z"

sort

string

Sort the result by execution_date.

Default
"execution_date"
Enum
  • execution_date

order

string

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default
"ASC"
Enum
  • ASC

offset

int

i32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

Response

ExamplesSchema

OK

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
      "created_at": "2023-07-21T14:10:00.00Z",
      "updated_at": "2023-07-21T15:10:00.00Z",
      "user_id": "4b9732bd-7496-4913-8a5f-6360479d7fed",
      "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
      "savings_plan_id": "c31083c1-1cd3-405f-95d1-f49a37f0e032",
      "order_id": "68068440-6b8e-4700-8cfc-95bf21b34b96",
      "cash_amount": "100",
      "currency": "EUR",
      "status": "FILLED",
      "type": "INSTRUMENT",
      "instrument_id": "DE0007664005",
      "instrument_id_type": "ISIN",
      "execution_date": "2023-10-05"
    }
  ]
}

Savings plan execution events

webhook

Savings plan execution events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

type

string

required

Event type

Enum
  • SAVINGS_PLAN_EXECUTION.NEW
  • SAVINGS_PLAN_EXECUTION.PROCESSING
  • SAVINGS_PLAN_EXECUTION.FILLED
  • SAVINGS_PLAN_EXECUTION.SETTLED
  • SAVINGS_PLAN_EXECUTION.CANCELLED

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "id": "54b8d84f-5bd0-4e43-bf0f-164388cb4c23",
  "created_at": "2023-07-21T10:00:00.00Z",
  "type": "SAVINGS_PLAN_EXECUTION.NEW",