Skip to content
Documentation
/
/
/
3. Placing portfolio orde...

Portfolio orders

Overview

Placing a portfolio order follows our standard order approach. However, instead of calculating the order volume for each individual instrument, you only need to specify the desired investment amount to place a portfolio order. The Investment API handles the conversion to individual orders in the background based on the instrument weight specified in the portfolio allocation.

Prerequisites

  • Authentication scopes — orders:admin, portfolios:admin

    For more information, refer to Authentication scopes.

  • Before a user can start investing, the account must be in ACTIVE status, which means that all checks have been passed.

  • Before the user can place a portfolio order, a portfolio configuration must exist. Make sure you've completed the first two steps in this guide before attempting this sub-task.

Placing a portfolio order

To place a portfolio order, send the following request:

POST /portfolios/orders

Example request

{
  "user_id": "4b9732bd-7496-4e91-8a5f-6360479d7fed",
  "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
  "cash_amount": "100.00",
  "currency": "EUR",
  "side": "BUY"
}

In the example request, a user has placed a portfolio order for 100€. Furthermore, the request returns a portfolio_order_id which allows you to transparently track the progress of a portfolio order in its entirety. You can find more details about this process in the guide 'Understanding portfolio orders'.

You'll receive an HTTP response indicating whether the request was correctly handled. Successful portfolio order creation will result in an HTTP 202 Accepted response containing a portfolio_order_id in its payload. Because order processing is asynchronous, further details and status updates will be delivered via webhooks.

See Asynchronous order processing and tracking for more details.

This concludes the step-by-step process of how to enable portfolio investments to your users from scratch. Now you have all the knowledge you need to start integrating the portfolio functionality into your application.

The Investment API supports self-balancing functionality. This ensures that after order execution, an end user’s current holdings match the defined portfolio allocation.

For more information, refer to the Configuring portfolio order distributions section of this guide.

Congratulations, you can now place portfolio orders!