Savings Plans
Download SpecAll savings plans related paths.
Retrieve a savings plan
Retrieve a savings plan specified by its ID.
savings_plan_id
string
uuid
required
oauth-client-credentials
Required Scopes:
savings_plans:readsavings_plans:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
taxes:admin· Modify tax residencies -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- 1
Response
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"
}{
"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": "Portfolio savings plan",
"type": "PORTFOLIO",
"cash_amount": "100.00",
"currency": "EUR",
"start_date": "2023-07-24",
"period": "WEEK",
"interval": 1,
"status": "ACTIVE"
}Empty response
Empty response
Empty response
Empty response
Empty response
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Method Not Allowed. The requested method is not allowed on the requested resource.
{
"status": 405,
"type": "method_not_allowed"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
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.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
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.
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
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
status
string
Status of a Savings Plan.
- ACTIVE -
- CANCELLED -
- Enum
-
- ACTIVE
- CANCELLED
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Delete a savings plan
Delete a savings plan specified by its ID.
savings_plan_id
string
uuid
required
oauth-client-credentials
Required Scopes:
savings_plans:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
taxes:admin· Modify tax residencies -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- 1
Response
The request has been successfully accepted and will be processed asynchronously.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Conflict. An operation is not available for the current state of the resource.
{
"status": 409,
"type": "conflict"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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"
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
oauth-client-credentials
Required Scopes:
savings_plans:readsavings_plans:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
taxes:admin· Modify tax residencies -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- 1
Response
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"
}
]
}{
"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": "Portfolio savings plan",
"type": "PORTFOLIO",
"cash_amount": "100.00",
"currency": "EUR",
"start_date": "2023-07-24",
"period": "WEEK",
"interval": 1,
"status": "ACTIVE"
}
]
}Empty response
Empty response
Empty response
Empty response
Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Method Not Allowed. The requested method is not allowed on the requested resource.
{
"status": 405,
"type": "method_not_allowed"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
meta
object (meta)
required
offset
int
required
Amount of resource to offset in the response.
limit
int
required
Total limit of the response.
count
int
required
Count of the resources returned in the response.
total_count
int
required
Total count of all the resources.
sort
string
The field that the list is sorted by.
order
string
The ordering of the response.
- ASC - Ascending order
- DESC - Descending order
- Enum
-
- ASC
- DESC
data
array[object (Savings plan)]
required
Savings plan
object (Savings plan)
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
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.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
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.
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
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
status
string
Status of a Savings Plan.
- ACTIVE -
- CANCELLED -
- Enum
-
- ACTIVE
- CANCELLED
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
oauth-client-credentials
Required Scopes:
savings_plans:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
taxes:admin· Modify tax residencies -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- 1
idempotency-key
string
uuid
^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$
required
A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency
- Example
- "ccb07f42-4104-44ad-8e1f-c660bb7b269c"
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
}{
"user_id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
"account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
"name": "Portfolio savings plan",
"type": "PORTFOLIO",
"cash_amount": "100.00",
"currency": "EUR",
"start_date": "2023-07-24",
"period": "WEEK",
"interval": 1
}Response
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"
}{
"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": "Portfolio savings plan",
"type": "PORTFOLIO",
"cash_amount": "100.00",
"currency": "EUR",
"start_date": "2023-07-24",
"period": "WEEK",
"interval": 1,
"status": "ACTIVE"
}Empty response
Empty response
Empty response
Empty response
Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Method Not Allowed. The requested method is not allowed on the requested resource.
{
"status": 405,
"type": "method_not_allowed"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
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.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
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.
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
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
status
string
Status of a Savings Plan.
- ACTIVE -
- CANCELLED -
- Enum
-
- ACTIVE
- CANCELLED
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Retrieve savings plan execution
Retrieve savings plan execution
savings_plan_id
string
uuid
required
savings_plan_execution_id
string
uuid
required
oauth-client-credentials
Required Scopes:
savings_plans:readsavings_plans:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
taxes:admin· Modify tax residencies -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- 1
Response
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"
}{
"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": "PORTFOLIO",
"execution_date": "2023-07-24"
}Empty response
Empty response
Empty response
Empty response
Empty response
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Method Not Allowed. The requested method is not allowed on the requested resource.
{
"status": 405,
"type": "method_not_allowed"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
uuid
required
User unique identifier.
account_id
string
uuid
required
Account unique identifier.
savings_plan_id
string
uuid
required
order_id
One Of
required
Order unique identifier (Portfolio order or Instrument order)
Portfolios order unique identifier
string
uuid
Order
object (Order)
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
uuid
required
The ID of the user
account_id
string
uuid
required
The ID of the account that owns the order
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
currency
string
required
- Enum
-
- EUR
side
string
required
Side of the order.
- BUY -
- SELL -
- Enum
-
- BUY
- SELL
instrument_id
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
required
International securities identification number defined by ISO 6166.
instrument_id_type
string
required
The type of the ID used in the request.
- ISIN -
- Default
- "ISIN"
- Enum
-
- ISIN
order_type
string
required
Type of the order.
- MARKET -
- LIMIT -
- STOP -
- Enum
-
- MARKET
- LIMIT
- STOP
quantity
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
user_instrument_fit_acknowledgement
boolean
Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
limit_price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
stop_price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
expiry_date
string
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
status
string
required
The execution status of the order.
- NEW -
- PROCESSING -
- FILLED -
- CANCELLED -
- Enum
-
- NEW
- PROCESSING
- FILLED
- CANCELLED
fee
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
cancellation_reason
string
Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED.
- CANCELLED_BY_CLIENT -
- CANCELLED_BY_UPVEST_OPERATIONS -
- CANCELLED_BY_TRADING_PARTNER -
- CANCELLED_BY_UPVEST_PLATFORM -
- Enum
-
- CANCELLED_BY_CLIENT
- CANCELLED_BY_UPVEST_OPERATIONS
- CANCELLED_BY_TRADING_PARTNER
- CANCELLED_BY_UPVEST_PLATFORM
initiation_flow
string
required
Initiation flow used during order creation, i.e. what triggered the order.
- API -
- PORTFOLIO -
- CASH_DIVIDEND_REINVESTMENT -
- PORTFOLIO_REBALANCING -
- SELL_TO_COVER_FEES -
- SELL_TO_COVER_TAXES -
- ACCOUNT_LIQUIDATION -
- UPVEST_OPERATIONS -
- SAVINGS_PLAN -
- Enum
-
- API
- PORTFOLIO
- CASH_DIVIDEND_REINVESTMENT
- PORTFOLIO_REBALANCING
- SELL_TO_COVER_FEES
- SELL_TO_COVER_TAXES
- ACCOUNT_LIQUIDATION
- UPVEST_OPERATIONS
- SAVINGS_PLAN
execution_flow
string
Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.
- STRAIGHT_THROUGH -
- BLOCK -
- Enum
-
- STRAIGHT_THROUGH
- BLOCK
executions
array[object (Order execution)]
required
Order executions associated with this order
Order execution
object (Order execution)
id
string
uuid
required
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
share_quantity
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
transaction_time
string
date-time
required
taxes
array[object (Tax)]
required
Tax
object (Tax)
type
string
required
Tax type
- TOTAL -
- Default
- "TOTAL"
- Enum
-
- TOTAL
amount
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
order_id
string
uuid
required
status
string
required
Execution status of the Execution.
- FILLED -
- SETTLED -
- CANCELLED -
- Enum
-
- FILLED
- SETTLED
- CANCELLED
side
string
required
Side of the execution.
- BUY -
- SELL -
- Enum
-
- BUY
- SELL
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
settlement_date
string
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
venue_id
string
uuid
required
The ID of the venue
client_reference
string
required
An ID provided by the client
- Max Length
- 100
fee_configuration
array[One Of]
fee configuration
Fee
One Of
Absolute Fee
object (Absolute Fee)
type
string
required
Fee type
- TRANSACTION_FEE_BUY -
- TRANSACTION_FEE_SELL -
- Enum
-
- TRANSACTION_FEE_BUY
- TRANSACTION_FEE_SELL
value_type
string
required
The value type must be “ABSOLUTE”.
- Default
- "ABSOLUTE"
charge_method
string
required
Indicates whether the fee will be charged by client or by other methods.
- CHARGED_BY_CLIENT -
- Default
- "CHARGED_BY_CLIENT"
- Enum
-
- CHARGED_BY_CLIENT
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
null
null
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
status
string
required
Status of a Savings Plan Execution.
- NEW -
- READY_FOR_EXECUTION -
- SUBMITTED -
- PROCESSING -
- FILLED -
- SETTLED -
- CANCELLED -
- Enum
-
- NEW
- READY_FOR_EXECUTION
- SUBMITTED
- PROCESSING
- FILLED
- SETTLED
- CANCELLED
type
string
required
Type of the Savings plan.
- PORTFOLIO -
- INSTRUMENT -
- Enum
-
- PORTFOLIO
- INSTRUMENT
execution_date
string
^[12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
required
Date of a savings plan execution in YYYY-MM-DD format.
instrument_id
One Of
Instrument unique identifier.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Delete savings plan execution
Delete savings plan execution
savings_plan_id
string
uuid
required
savings_plan_execution_id
string
uuid
required
oauth-client-credentials
Required Scopes:
savings_plans:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
taxes:admin· Modify tax residencies -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- 1
Response
The request has been successfully accepted and will be processed asynchronously.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Conflict. An operation is not available for the current state of the resource.
{
"status": 409,
"type": "conflict"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
List savings plan 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
savings_plan_id
string
uuid
required
oauth-client-credentials
Required Scopes:
savings_plans:readsavings_plans:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
taxes:admin· Modify tax residencies -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- 1
Response
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"
}
]
}{
"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": "PORTFOLIO",
"execution_date": "2023-10-05"
}
]
}Empty response
Empty response
Empty response
Empty response
Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Method Not Allowed. The requested method is not allowed on the requested resource.
{
"status": 405,
"type": "method_not_allowed"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
meta
object (meta)
required
offset
int
required
Amount of resource to offset in the response.
limit
int
required
Total limit of the response.
count
int
required
Count of the resources returned in the response.
total_count
int
required
Total count of all the resources.
sort
string
The field that the list is sorted by.
order
string
The ordering of the response.
- ASC - Ascending order
- DESC - Descending order
- Enum
-
- ASC
- DESC
data
array[object (Savings plan)]
required
Savings plan
object (Savings plan)
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
uuid
required
User unique identifier.
account_id
string
uuid
required
Account unique identifier.
savings_plan_id
string
uuid
required
order_id
One Of
required
Order unique identifier (Portfolio order or Instrument order)
Portfolios order unique identifier
string
uuid
Order
object (Order)
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
uuid
required
The ID of the user
account_id
string
uuid
required
The ID of the account that owns the order
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
currency
string
required
- Enum
-
- EUR
side
string
required
Side of the order.
- BUY -
- SELL -
- Enum
-
- BUY
- SELL
instrument_id
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
required
International securities identification number defined by ISO 6166.
instrument_id_type
string
required
The type of the ID used in the request.
- ISIN -
- Default
- "ISIN"
- Enum
-
- ISIN
order_type
string
required
Type of the order.
- MARKET -
- LIMIT -
- STOP -
- Enum
-
- MARKET
- LIMIT
- STOP
quantity
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
user_instrument_fit_acknowledgement
boolean
Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
limit_price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
stop_price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
expiry_date
string
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
status
string
required
The execution status of the order.
- NEW -
- PROCESSING -
- FILLED -
- CANCELLED -
- Enum
-
- NEW
- PROCESSING
- FILLED
- CANCELLED
fee
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
cancellation_reason
string
Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED.
- CANCELLED_BY_CLIENT -
- CANCELLED_BY_UPVEST_OPERATIONS -
- CANCELLED_BY_TRADING_PARTNER -
- CANCELLED_BY_UPVEST_PLATFORM -
- Enum
-
- CANCELLED_BY_CLIENT
- CANCELLED_BY_UPVEST_OPERATIONS
- CANCELLED_BY_TRADING_PARTNER
- CANCELLED_BY_UPVEST_PLATFORM
initiation_flow
string
required
Initiation flow used during order creation, i.e. what triggered the order.
- API -
- PORTFOLIO -
- CASH_DIVIDEND_REINVESTMENT -
- PORTFOLIO_REBALANCING -
- SELL_TO_COVER_FEES -
- SELL_TO_COVER_TAXES -
- ACCOUNT_LIQUIDATION -
- UPVEST_OPERATIONS -
- SAVINGS_PLAN -
- Enum
-
- API
- PORTFOLIO
- CASH_DIVIDEND_REINVESTMENT
- PORTFOLIO_REBALANCING
- SELL_TO_COVER_FEES
- SELL_TO_COVER_TAXES
- ACCOUNT_LIQUIDATION
- UPVEST_OPERATIONS
- SAVINGS_PLAN
execution_flow
string
Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.
- STRAIGHT_THROUGH -
- BLOCK -
- Enum
-
- STRAIGHT_THROUGH
- BLOCK
executions
array[object (Order execution)]
required
Order executions associated with this order
Order execution
object (Order execution)
id
string
uuid
required
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
share_quantity
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
transaction_time
string
date-time
required
taxes
array[object (Tax)]
required
Tax
object (Tax)
type
string
required
Tax type
- TOTAL -
- Default
- "TOTAL"
- Enum
-
- TOTAL
amount
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
order_id
string
uuid
required
status
string
required
Execution status of the Execution.
- FILLED -
- SETTLED -
- CANCELLED -
- Enum
-
- FILLED
- SETTLED
- CANCELLED
side
string
required
Side of the execution.
- BUY -
- SELL -
- Enum
-
- BUY
- SELL
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
settlement_date
string
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
venue_id
string
uuid
required
The ID of the venue
client_reference
string
required
An ID provided by the client
- Max Length
- 100
fee_configuration
array[One Of]
fee configuration
Fee
One Of
Absolute Fee
object (Absolute Fee)
type
string
required
Fee type
- TRANSACTION_FEE_BUY -
- TRANSACTION_FEE_SELL -
- Enum
-
- TRANSACTION_FEE_BUY
- TRANSACTION_FEE_SELL
value_type
string
required
The value type must be “ABSOLUTE”.
- Default
- "ABSOLUTE"
charge_method
string
required
Indicates whether the fee will be charged by client or by other methods.
- CHARGED_BY_CLIENT -
- Default
- "CHARGED_BY_CLIENT"
- Enum
-
- CHARGED_BY_CLIENT
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
null
null
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
status
string
required
Status of a Savings Plan Execution.
- NEW -
- READY_FOR_EXECUTION -
- SUBMITTED -
- PROCESSING -
- FILLED -
- SETTLED -
- CANCELLED -
- Enum
-
- NEW
- READY_FOR_EXECUTION
- SUBMITTED
- PROCESSING
- FILLED
- SETTLED
- CANCELLED
type
string
required
Type of the Savings plan.
- PORTFOLIO -
- INSTRUMENT -
- Enum
-
- PORTFOLIO
- INSTRUMENT
execution_date
string
^[12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
required
Date of a savings plan execution in YYYY-MM-DD format.
instrument_id
One Of
Instrument unique identifier.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
uuid
required
User unique identifier.
account_id
string
uuid
required
Account unique identifier.
savings_plan_id
string
uuid
required
order_id
One Of
required
Order unique identifier (Portfolio order or Instrument order)
Portfolios order unique identifier
string
uuid
Order
object (Order)
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
uuid
required
The ID of the user
account_id
string
uuid
required
The ID of the account that owns the order
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
currency
string
required
- Enum
-
- EUR
side
string
required
Side of the order.
- BUY -
- SELL -
- Enum
-
- BUY
- SELL
instrument_id
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
required
International securities identification number defined by ISO 6166.
instrument_id_type
string
required
The type of the ID used in the request.
- ISIN -
- Default
- "ISIN"
- Enum
-
- ISIN
order_type
string
required
Type of the order.
- MARKET -
- LIMIT -
- STOP -
- Enum
-
- MARKET
- LIMIT
- STOP
quantity
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
user_instrument_fit_acknowledgement
boolean
Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
limit_price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
stop_price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
expiry_date
string
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
status
string
required
The execution status of the order.
- NEW -
- PROCESSING -
- FILLED -
- CANCELLED -
- Enum
-
- NEW
- PROCESSING
- FILLED
- CANCELLED
fee
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
cancellation_reason
string
Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED.
- CANCELLED_BY_CLIENT -
- CANCELLED_BY_UPVEST_OPERATIONS -
- CANCELLED_BY_TRADING_PARTNER -
- CANCELLED_BY_UPVEST_PLATFORM -
- Enum
-
- CANCELLED_BY_CLIENT
- CANCELLED_BY_UPVEST_OPERATIONS
- CANCELLED_BY_TRADING_PARTNER
- CANCELLED_BY_UPVEST_PLATFORM
initiation_flow
string
required
Initiation flow used during order creation, i.e. what triggered the order.
- API -
- PORTFOLIO -
- CASH_DIVIDEND_REINVESTMENT -
- PORTFOLIO_REBALANCING -
- SELL_TO_COVER_FEES -
- SELL_TO_COVER_TAXES -
- ACCOUNT_LIQUIDATION -
- UPVEST_OPERATIONS -
- SAVINGS_PLAN -
- Enum
-
- API
- PORTFOLIO
- CASH_DIVIDEND_REINVESTMENT
- PORTFOLIO_REBALANCING
- SELL_TO_COVER_FEES
- SELL_TO_COVER_TAXES
- ACCOUNT_LIQUIDATION
- UPVEST_OPERATIONS
- SAVINGS_PLAN
execution_flow
string
Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.
- STRAIGHT_THROUGH -
- BLOCK -
- Enum
-
- STRAIGHT_THROUGH
- BLOCK
executions
array[object (Order execution)]
required
Order executions associated with this order
Order execution
object (Order execution)
id
string
uuid
required
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
share_quantity
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
price
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
transaction_time
string
date-time
required
taxes
array[object (Tax)]
required
Tax
object (Tax)
type
string
required
Tax type
- TOTAL -
- Default
- "TOTAL"
- Enum
-
- TOTAL
amount
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
order_id
string
uuid
required
status
string
required
Execution status of the Execution.
- FILLED -
- SETTLED -
- CANCELLED -
- Enum
-
- FILLED
- SETTLED
- CANCELLED
side
string
required
Side of the execution.
- BUY -
- SELL -
- Enum
-
- BUY
- SELL
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
settlement_date
string
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
venue_id
string
uuid
required
The ID of the venue
client_reference
string
required
An ID provided by the client
- Max Length
- 100
fee_configuration
array[One Of]
fee configuration
Fee
One Of
Absolute Fee
object (Absolute Fee)
type
string
required
Fee type
- TRANSACTION_FEE_BUY -
- TRANSACTION_FEE_SELL -
- Enum
-
- TRANSACTION_FEE_BUY
- TRANSACTION_FEE_SELL
value_type
string
required
The value type must be “ABSOLUTE”.
- Default
- "ABSOLUTE"
charge_method
string
required
Indicates whether the fee will be charged by client or by other methods.
- CHARGED_BY_CLIENT -
- Default
- "CHARGED_BY_CLIENT"
- Enum
-
- CHARGED_BY_CLIENT
cash_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
null
null
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
status
string
required
Status of a Savings Plan Execution.
- NEW -
- READY_FOR_EXECUTION -
- SUBMITTED -
- PROCESSING -
- FILLED -
- SETTLED -
- CANCELLED -
- Enum
-
- NEW
- READY_FOR_EXECUTION
- SUBMITTED
- PROCESSING
- FILLED
- SETTLED
- CANCELLED
type
string
required
Type of the Savings plan.
- PORTFOLIO -
- INSTRUMENT -
- Enum
-
- PORTFOLIO
- INSTRUMENT
execution_date
string
^[12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
required
Date of a savings plan execution in YYYY-MM-DD format.
instrument_id
One Of
Instrument unique identifier.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
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",
"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"
}{
"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": "PORTFOLIO",
"execution_date": "2023-07-23"
},
"webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}Response
Request has been processed successfully.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
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.CREATED
- SAVINGS_PLAN.UPDATED
- SAVINGS_PLAN.CANCELLED
object
object (object)
required
id
string
uuid
required
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
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.
International securities identification number
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
German securities identification code
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
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
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.
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
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
status
string
Status of a Savings Plan.
- ACTIVE -
- CANCELLED -
- Enum
-
- ACTIVE
- CANCELLED
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.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"
}{
"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": "Portfolio savings plan",
"type": "PORTFOLIO",
"cash_amount": "100.00",
"currency": "EUR",
"start_date": "2023-07-24",
"period": "WEEK",
"interval": 1,
"status": "ACTIVE"
},
"webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}Response
Request has been processed successfully.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?