All savings plans related paths.
/savings_plans/{savings_plan_id}
Retrieve a savings plan specified by its ID.
savings_plan_id
string
required
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"
}
/savings_plans/{savings_plan_id}
Delete a savings plan specified by its ID.
savings_plan_id
string
required
The request has been successfully accepted and will be processed asynchronously.
Empty response
/savings_plans
List savings plans
account_id
string
Filters savings plans by account ID
user_id
string
Filters savings plans by user ID
instrument_id
One Of
Filters savings plans by instrument ID (ISIN)
Must match one of
International securities identification number defined by ISO 6166.
sort
string
Sort the result by id
.
order
string
Sort order of the result list if the sort
parameter is specified. By default, only ASC for ascending sort.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
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"
}
]
}
/savings_plans
Create savings plan
user_id
string
required
User unique identifier.
account_id
string
required
Account unique identifier.
name
string
Savings plan name
type
string
required
Type of the Savings plan.
instrument_id
One Of
Instrument unique identifier.
Must match one of
International securities identification number defined by ISO 6166.
instrument_id_type
string
The type of the ID used in the request.
cash_amount
string
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
start_date
string
required
First date of the savings plan execution in YYYY-MM-DD format.
period
string
required
Unit of time.
interval
int
required
Number of periods between executions
{
"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
}
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"
}
/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}
Retrieve savings plan execution
savings_plan_id
string
required
savings_plan_execution_id
string
required
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"
}
/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}
Delete savings plan execution
savings_plan_id
string
required
savings_plan_execution_id
string
required
The request has been successfully accepted and will be processed asynchronously.
Empty response
/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)
end_date
string
Returns savings plan executions up to this date (UTC)
sort
string
Sort the result by execution_date
.
order
string
Sort order of the result list if the sort
parameter is specified. By default, only ASC for ascending sort.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
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"
}
]
}
id
string
required
Event unique identifier
created_at
string
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
object
object (Savings plan)
required
id
string
required
created_at
string
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
required
User unique identifier.
account_id
string
required
Account unique identifier.
savings_plan_id
string
required
order_id
One Of
required
Order unique identifier (Portfolio order or Instrument order)
Must match one of
cash_amount
string
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
status
string
required
Status of a Savings Plan Execution.
type
string
required
Type of the Savings plan.
execution_date
string
required
Date of a savings plan execution in YYYY-MM-DD format.
instrument_id
One Of
Instrument unique identifier.
Must match one of
instrument_id_type
string
The type of the ID used in the request.
webhook_id
string
required
Webhook unique identifier.
{
"id": "54b8d84f-5bd0-4e43-bf0f-164388cb4c23",
"created_at": "2023-07-21T10:00:00.00Z",
"type": "SAVINGS_PLAN_EXECUTION.NEW",
"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",
"savings_plan_id": "c31083c1-1cd3-405f-95d1-f49a37f0e032",
"order_id": null,
"cash_amount": "100",
"currency": "EUR",
"status": "NEW",
"type": "INSTRUMENT",
"instrument_id": "DE0007664005",
"instrument_id_type": "ISIN",
"execution_date": "2023-07-23"
},
"webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}
Request has been processed successfully.
Empty response
id
string
required
Event unique identifier
created_at
string
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
object
object (Savings plan)
required
id
string
required
created_at
string
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
required
User unique identifier.
account_id
string
required
Account unique identifier.
name
string
Savings plan name
type
string
required
Type of the Savings plan.
instrument_id
One Of
Instrument unique identifier.
Must match one of
instrument_id_type
string
The type of the ID used in the request.
cash_amount
string
required
start_date
string
required
First date of the savings plan execution in YYYY-MM-DD format.
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
period
string
required
Unit of time.
interval
int
required
Number of periods between executions
status
string
Status of a Savings Plan.
webhook_id
string
required
Webhook unique identifier.
{
"id": "54b8d84f-5bd0-4e43-bf0f-164388cb4c23",
"created_at": "2023-07-21T10:00:00.00Z",
"type": "SAVINGS_PLAN.CREATED",
"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"
},
"webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}
Request has been processed successfully.
Empty response
Was this page helpful?