Skip to content
/
Order Cancellations event...

Upvest Investment API (1.83.0)

Upvest Investment API.

Download OpenAPI description
Upvest-Investment-API.v1.json
Upvest-Investment-API.v1.yaml
Overview
URL
https://docs.upvest.co
Upvest API Support
api@upvest.co
License
Apache 2.0
Languages
Servers
Sandbox environment
https://sandbox.upvest.co
Live environment
https://api.upvest.co

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

Operations
Webhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

Operations
Webhooks

Accounts

All accounts related paths

Operations
Webhooks

Account Groups

All account groups related paths

Operations
Webhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Wrappers

All tax wrappers related paths

Operations
Webhooks

Tax Exemptions

All tax exemptions related paths

Operations
Webhooks

Tax Collections

All tax collections related paths

Webhooks

Instruments

All instrument related paths.

Operations
Webhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

Operations
Webhooks

Executions eventsWebhook

Request

Executions events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

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

typestringrequired

Event type

Enum"EXECUTION.FILLED""EXECUTION.SETTLED""EXECUTION.CANCELLED"
objectobjectrequired
idstring(uuid)required
cash_amountstring^[0-9]{1,9}(\.[0-9]{2})?$required
share_quantitystring^[0-9]{0,63}(\.[0-9]{1,27})?$required
pricestring^[0-9]{0,63}(\.[0-9]{1,4})?$required
transaction_timestring(date-time)required
taxesArray of objectsrequired
typestringrequired

Tax type

  • TOTAL -
Default "TOTAL"
Value"TOTAL"
amountstring^[0-9]{0,63}(\.[0-9]{1,27})?$required
order_idstring(uuid)required
statusstringrequired

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum"FILLED""SETTLED""CANCELLED"
sidestringrequired

Side of the execution.

  • BUY -
  • SELL -
Enum"BUY""SELL"
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - British Pound
Enum"EUR""GBP"
venue_idstring(uuid)required

The ID of the venue

settlement_datestring^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Order execution settlement date in the YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2022-11-17T10:42:34.758Z",
  "type": "EXECUTION.FILLED",
  "object": {
    "cash_amount": "852.20",
    "currency": "EUR",
    "id": "b40f4631-e83b-4737-a003-c0cb36382bc5",
    "order_id": "cd2d6019-c11d-4114-aab3-b2e5dbe58cbf",
    "price": "85.22",
    "share_quantity": "10",
    "side": "BUY",
    "status": "FILLED",
    "taxes": [ … ],
    "transaction_time": "2022-11-17T10:42:34.758Z",
    "venue_id": "20d6024b-2df4-41ae-8d42-62e4744e455b"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Responses

Request has been processed successfully.

Order Cancellations eventsWebhook

Request

Order Cancellations events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

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

typestringrequired

Event type

Value"ORDER_CANCELLATION.REJECTED"
objectobjectrequired
order_idstring(uuid)required
statusstringrequired

Status of the order cancellation process

Value"REJECTED"
reasonstring

Reason behind order cancellation rejection.

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "e0b1f0ac-d34a-4f07-b268-545278110231",
  "created_at": "2023-08-01T14:10:00.00Z",
  "type": "ORDER_CANCELLATION.REJECTED",
  "object": {
    "order_id": "120c5382-d400-4a8e-95fc-d297903f3568",
    "status": "REJECTED",
    "reason": "Cancellation not possible"
  },
  "webhook_id": "0e225118-168c-4d4d-84d9-c36096163162"
}

Responses

Request has been processed successfully.

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

Operations
Webhooks

Savings Plans

All savings plans related paths.

Operations
Webhooks

Liquidations

All accounts liquidations related paths.

Operations
Webhooks

Direct Debits

All direct debits related paths

Operations
Webhooks

Top-ups

All top-ups related paths

Operations
Webhooks

Withdrawals

All withdrawals related paths

Operations
Webhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

Operations
Webhooks

Credit Fundings

All credit fundings related paths

Operations
Webhooks

Cash Balances

All cash balance related paths

Operations
Webhooks

Positions

All positions related paths.

Operations
Webhooks

Valuations

All valuations related paths.

Operations
Webhooks

Returns

All accounts returns related paths.

Operations
Webhooks

Virtual Cash Balances

All virtual cash balances related paths

Operations
Webhooks

Fees

All fees related paths.

Operations
Webhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

Operations
Webhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

Operations
Webhooks

Files

All files API related paths.

Operations

Account Transfers

All Accounts Transfers related paths.

Operations
Webhooks

Securities Transfers

All Securities Transfers related paths.

Operations
Webhooks

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Tests

All test related paths.

Operations