Sign in
Portfolios

Create portfolios order

Create portfolios order

post/portfolios/orders

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

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

Request body

user_idstring uuid required

User unique identifier.

account_idstring uuid required

Account unique identifier.

cash_amountstring required
currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
side'BUY' | 'SELL' required

Side of the portfolio order.

  • BUY -
  • SELL -
post_taxboolean

Cash amount is post-tax value

Response

Portfolios order

idstring uuid required
created_atstring date-time required

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

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

user_idstring uuid

User unique identifier.

account_idstring uuid required

Account unique identifier.

allocation_idstring uuid
cash_amountstring required
currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
status'NEW' | 'PROCESSING' | 'FILLED' | 'SETTLED' | 'CANCELLED' required

Execution status of the Portfolio Order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • SETTLED -
  • CANCELLED -
type'BUY' | 'SELL' | 'REBALANCING'

Type of the Portfolio Order.

  • BUY -
  • SELL -
  • REBALANCING -
post_taxboolean required

Cash amount is post-tax value

client_referencestring required
initiation_flow'API' | 'SAVINGS_PLAN' required

What triggered the order creation .

  • API -
  • SAVINGS_PLAN -
cancellation_reason'ACCOUNT_IS_EMPTY' | 'CANCELLED_BY_CLIENT' | 'CANCELLED_BY_UPVEST' | 'PORTFOLIO_IS_BALANCED' | 'SELL_LIMIT_EXCEEDED'

Explains the reason why the order was cancelled .

  • ACCOUNT_IS_EMPTY -
  • CANCELLED_BY_CLIENT -
  • CANCELLED_BY_UPVEST -
  • PORTFOLIO_IS_BALANCED -
  • SELL_LIMIT_EXCEEDED -
cancellation_detailsstring