Skip to content
API Reference/
/
Security transactions eve...

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.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.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Cash transactions eventsWebhook

Request

Cash transactions 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

Default "CASH_TRANSACTION.EXECUTED"
Value"CASH_TRANSACTION.EXECUTED"
objectobjectrequired
idstring(uuid)required

Cash transaction unique identifier.

typestringrequired

Transaction type

  • ACCUMULATION - Accumulation
  • ACCUMULATION_CANCELLATION - Accumulation cancellation
  • ANNUAL_GENERAL_MEETING - Annual general meeting
  • ANNUAL_GENERAL_MEETING_CANCELLATION - Annual general meeting cancellation
  • ATTACHMENT - Attachment
  • ATTACHMENT_CANCELLATION - Attachment cancellation
  • BALANCE_CORRECTION - Balance correction
  • BALANCE_CORRECTION_CANCELLATION - Balance correction cancellation
  • BANKRUPTCY - Bankruptcy
  • BANKRUPTCY_CANCELLATION - Bankruptcy cancellation
  • BOND_DEFAULT - Bond default
  • BOND_DEFAULT_CANCELLATION - Bond default cancellation
  • BOND_HOLDER_MEETING - Bond holder meeting
  • BOND_HOLDER_MEETING_CANCELLATION - Bond holder meeting cancellation
  • BONUS_ISSUE - Bonus Issue/Capitalisation Issue
  • BONUS_ISSUE_CANCELLATION - Bonus Issue/Capitalisation Issue, Cancellation
  • CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities cancellation
  • CAPITAL_DISTRIBUTION - Capital distribution
  • CAPITAL_DISTRIBUTION_CANCELLATION - Capital distribution cancellation
  • CAPITAL_GAINS_DISTRIBUTION - Capital gains distribution
  • CAPITAL_GAINS_DISTRIBUTION_CANCELLATION - Capital gains distribution cancellation
  • CAPITALISATION - Capitalisation
  • CAPITALISATION_CANCELLATION - Capitalisation cancellation
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES - Cash distribution from non eligible securities sales
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION - Cash distribution from non eligible securities sales cancellation
  • CASH_DIVIDEND - Cash dividend
  • CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation
  • CHANGE - Change
  • CHANGE_CANCELLATION - Change, Cancellation
  • CLASS_ACTION - Class action
  • CLASS_ACTION_CANCELLATION - Class action cancellation
  • COMPANY_OPTION - Company option
  • COMPANY_OPTION_CANCELLATION - Company option cancellation
  • CONSENT - Consent
  • CONSENT_CANCELLATION - Consent cancellation
  • CONVERSION - Conversion
  • CONVERSION_CANCELLATION - Conversion cancellation
  • COURT_MEETING - Court meeting
  • COURT_MEETING_CANCELLATION - Court meeting cancellation
  • CREDIT_EVENT - Credit event
  • CREDIT_EVENT_CANCELLATION - Credit event cancellation
  • CREDIT_FUNDING - Credit funding
  • CREDIT_FUNDING_CHARGE_BACK - Credit funding charge back
  • DD_REFUND_REJECT_FEE - DD refund reject fee
  • DD_REFUND_REJECT_FEE_CANCELLATION - DD refund reject fee cancellation
  • DECREASE_IN_VALUE - Decrease in Value
  • DECREASE_IN_VALUE_CANCELLATION - Decrease in Value, Cancellation
  • DETACHMENT - Detachment
  • DETACHMENT_CANCELLATION - Detachment cancellation
  • DISCLOSURE - Disclosure
  • DISCLOSURE_CANCELLATION - Disclosure cancellation
  • DIVIDEND_OPTION - Dividend Option
  • DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation
  • DIVIDEND_REINVESTMENT - Dividend Reinvestment
  • DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation
  • DRAWING - Drawing
  • DRAWING_CANCELLATION - Drawing cancellation
  • DUTCH_AUCTION - Dutch Auction
  • DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation
  • EXCHANGE - Exchange
  • EXCHANGE_CANCELLATION - Exchange cancellation
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING - Extraordinary or special general meeting
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION - Extraordinary or special general meeting cancellation
  • FEE_COLLECTION - Fee collection
  • FEE_COLLECTION_CANCELLATION - Fee collection cancellation
  • FINAL_MATURITY - Final maturity
  • FINAL_MATURITY_CANCELLATION - Final maturity cancellation
  • FULL_CALL - Full call
  • FULL_CALL_CANCELLATION - Full call cancellation
  • INCREASE_IN_VALUE - Increase in Value
  • INCREASE_IN_VALUE_CANCELLATION - Increase in Value, Cancellation
  • INFORMATION - Information
  • INFORMATION_CANCELLATION - Information cancellation
  • INSTALMENT_CALL - Instalment call
  • INSTALMENT_CALL_CANCELLATION - Instalment call cancellation
  • INTEREST_PAYMENT - Interest payment
  • INTEREST_PAYMENT_CANCELLATION - Interest payment cancellation
  • INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation
  • LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment
  • LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation
  • MATURITY_EXTENSION - Maturity extension
  • MATURITY_EXTENSION_CANCELLATION - Maturity extension cancellation
  • MERGER - Merger
  • MERGER_CANCELLATION - Merger, Cancellation
  • NON_OFFICIAL_OFFER - Non-Official Offer
  • NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, Cancellation
  • NON_US_TEFRA_D_CERTIFICATION - Non us tefra d certification
  • NON_US_TEFRA_D_CERTIFICATION_CANCELLATION - Non us tefra d certification cancellation
  • ODD_LOT_SALE - Odd Lot Sale/Purchase
  • ODD_LOT_SALE_CANCELLATION - Odd Lot Sale/Purchase, Cancellation
  • ORDER_EXECUTION - Order execution
  • ORDER_EXECUTION_CANCELLATION - Order execution cancellation
  • ORDINARY_GENERAL_MEETING - Ordinary general meeting
  • ORDINARY_GENERAL_MEETING_CANCELLATION - Ordinary general meeting cancellation
  • OTHER_EVENT - Other Event
  • OTHER_EVENT_CANCELLATION - Other Event, Cancellation
  • PARI_PASSU - Pari passu
  • PARI_PASSU_CANCELLATION - Pari passu cancellation
  • PARTIAL_DEFEASANCE - Partial defeasance
  • PARTIAL_DEFEASANCE_CANCELLATION - Partial defeasance cancellation
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION - Partial redemption with pool factor reduction
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption with pool factor reduction cancellation
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION - Partial redemption without pool factor reduction
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption without pool factor reduction cancellation
  • PAY_IN_KIND - Pay in kind
  • PAY_IN_KIND_CANCELLATION - Pay in kind cancellation
  • PEAK_FRACTION_COMPENSATION - Peak fraction compensation
  • PEAK_ORDER_ADJUSTMENT - Peak order adjustment
  • PLACE_OF_INCORPORATION - Place of incorporation
  • PLACE_OF_INCORPORATION_CANCELLATION - Place of incorporation cancellation
  • PRIORITY_ISSUE - Priority Issue
  • PRIORITY_ISSUE_CANCELLATION - Priority Issue, Cancellation
  • PUT_REDEMPTION - Put redemption
  • PUT_REDEMPTION_CANCELLATION - Put redemption cancellation
  • REDENOMINATION - Redenomination
  • REDENOMINATION_CANCELLATION - Redenomination cancellation
  • REMARKETING_AGREEMENT - Remarketing agreement
  • REMARKETING_AGREEMENT_CANCELLATION - Remarketing agreement cancellation
  • REPURCHASE_OFFER - Repurchase Offer/Issuer Bid/Reverse Rights
  • REPURCHASE_OFFER_CANCELLATION - Repurchase Offer/Issuer Bid/Reverse Rights, Cancellation
  • REVERSE_STOCK_SPLIT - Reverse Stock Split/Change in Nominal Value
  • REVERSE_STOCK_SPLIT_CANCELLATION - Reverse Stock Split/Change in Nominal Value, Cancellation
  • RIGHTS_ISSUE - Rights Issue/Subscription Rights/Rights Offer
  • RIGHTS_ISSUE_CANCELLATION - Rights Issue/Subscription Rights/Rights Offer, Cancellation
  • SCRIP_DIVIDEND - Scrip dividend
  • SCRIP_DIVIDEND_CANCELLATION - Scrip dividend cancellation
  • SEPA_DIRECT_DEBIT - Sepa direct debit
  • SEPA_DIRECT_DEBIT_CHARGE_BACK - Sepa direct debit charge back
  • SHARES_PREMIUM_DIVIDEND - Shares Premium Dividend
  • SHARES_PREMIUM_DIVIDEND_CANCELLATION - Shares Premium Dividend, Cancellation
  • SMALLEST_NEGOTIABLE_UNIT - Smallest negotiable unit
  • SMALLEST_NEGOTIABLE_UNIT_CANCELLATION - Smallest negotiable unit cancellation
  • SPIN_OFF - Spin-Off
  • SPIN_OFF_CANCELLATION - Spin-Off, Cancellation
  • STOCK_DIVIDEND - Stock Dividend
  • STOCK_DIVIDEND_CANCELLATION - Stock Dividend, Cancellation
  • STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision
  • STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS - Tax on non distributed proceeds
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION - Tax on non distributed proceeds cancellation
  • TAX_OPTIMISATION - Tax optimisation
  • TAX_PAYMENT - Tax payment
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_RECLAIM - Tax reclaim
  • TAX_RECLAIM_CANCELLATION - Tax reclaim cancellation
  • TAX_REFUND - Tax refund
  • TENDER - Tender/Acquisition/Takeover/Purchase Offer
  • TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation
  • TOPUP - Cash top up
  • TOPUP_CANCELLATION - Top up cancellation
  • TRADING_STATUS_ACTIVE - Trading status active
  • TRADING_STATUS_ACTIVE_CANCELLATION - Trading status active cancellation
  • TRADING_STATUS_DELISTED - Trading status delisted
  • TRADING_STATUS_DELISTED_CANCELLATION - Trading status delisted cancellation
  • TRADING_STATUS_SUSPENDED - Trading status suspended
  • TRADING_STATUS_SUSPENDED_CANCELLATION - Trading status suspended cancellation
  • TREASURY_PAYMENT - Treasury payment
  • VIRTUAL_CASH_CORRECTION - Virtual cash correction
  • VIRTUAL_CASH_CORRECTION_CANCELLATION - Virtual cash correction cancellation
  • VIRTUAL_CASH_DECREASE - Virtual cash decreased
  • VIRTUAL_CASH_INCREASE - Virtual cash increased
  • WARRANT_EXERCISE - Warrant exercise
  • WARRANT_EXERCISE_CANCELLATION - Warrant exercise cancellation
  • WITHDRAWAL - Withdrawal
  • WITHDRAWAL_CANCELLATION - Withdrawal cancellation
  • WORTHLESS - Worthless
  • WORTHLESS_CANCELLATION - Worthless, Cancellation
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION - Withholding tax relief certification
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION - Withholding tax relief certification cancellation
Enum"ACCUMULATION""ACCUMULATION_CANCELLATION""ANNUAL_GENERAL_MEETING""ANNUAL_GENERAL_MEETING_CANCELLATION""ATTACHMENT""ATTACHMENT_CANCELLATION""BALANCE_CORRECTION""BALANCE_CORRECTION_CANCELLATION""BANKRUPTCY""BANKRUPTCY_CANCELLATION"
account_group_idstring(uuid)required

Account group unique identifier.

deltaobjectrequired

Entity representing cash transaction delta.

amountstring^-?[0-9]{1,9}(\.[0-9]{2})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
taxesArray of objectsrequired
amountstring^-?[0-9]{1,9}(\.[0-9]{2})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
typestringrequired

Type of the tax.

  • TOTAL - Total taxes
Default "TOTAL"
Value"TOTAL"
referencesArray of objectsrequired
idstring(uuid)required

Unique identifier for a resource of given type.

typestringrequired

Type of the reference.

  • CORPORATE_ACTION - Corporate action
  • CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction ID
  • CREDIT_FUNDING - Credit Funding
  • DIRECT_DEBIT - Direct debit funding request
  • FEE_COLLECTION - Fee collection
  • ORDER - Order
  • ORDER_EXECUTION - Order execution
  • TAX_TRANSACTION - Tax transaction
  • TOPUP - Cash top up
  • TRANSACTION_FEE_EXECUTION - Transaction fee execution
  • VIRTUAL_CASH_DECREASE - Virtual cash decreased
  • VIRTUAL_CASH_INCREASE - Virtual cash increased
  • WITHDRAWAL - Cash withdrawal
Enum"CORPORATE_ACTION""CORPORATE_ACTION_TRANSACTION_ID""CREDIT_FUNDING""DIRECT_DEBIT""FEE_COLLECTION""ORDER""ORDER_EXECUTION""TAX_TRANSACTION""TOPUP""TRANSACTION_FEE_EXECUTION"
booking_datestring(date-time)required

Transaction booking date and time. RFC 3339-5, ISO8601 UTC

value_datestring(date-time)required

Transaction value date and time. RFC 3339-5, ISO8601 UTC

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

instrumentobject

Entity representing instrument.

account_idstring(uuid)

Account unique identifier.

feesArray of objects
property name*anyadditional property
webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "55a877ce-effa-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00.000Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "created_at": "2023-01-01T00:00:00.000Z",
    "updated_at": "2023-01-01T00:00:00.000Z",
    "type": "CASH_DIVIDEND",
    "account_id": "0255e6c4-effa-11ed-a05b-0242ac120003",
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "instrument": { … },
    "delta": { … },
    "taxes": [ … ],
    "references": [ … ],
    "booking_date": "2023-01-01T00:00:00.000Z",
    "value_date": "2023-01-01T00:00:00.000Z"
  },
  "webhook_id": "9d3ac2e0-effa-11ed-a05b-0242ac120003"
}

Responses

Request has been processed successfully.

Security transactions eventsWebhook

Request

Security transactions 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

Default "SECURITY_TRANSACTION.EXECUTED"
Value"SECURITY_TRANSACTION.EXECUTED"
objectobjectrequired
idstring(uuid)required

Security transaction unique identifier.

typestringrequired

Transaction type

  • ACCUMULATION - Accumulation
  • ACCUMULATION_CANCELLATION - Accumulation cancellation
  • ANNUAL_GENERAL_MEETING - Annual general meeting
  • ANNUAL_GENERAL_MEETING_CANCELLATION - Annual general meeting cancellation
  • ATTACHMENT - Attachment
  • ATTACHMENT_CANCELLATION - Attachment cancellation
  • BALANCE_CORRECTION - Balance correction
  • BALANCE_CORRECTION_CANCELLATION - Balance correction cancellation
  • BANKRUPTCY - Bankruptcy
  • BANKRUPTCY_CANCELLATION - Bankruptcy cancellation
  • BOND_DEFAULT - Bond default
  • BOND_DEFAULT_CANCELLATION - Bond default cancellation
  • BOND_HOLDER_MEETING - Bond holder meeting
  • BOND_HOLDER_MEETING_CANCELLATION - Bond holder meeting cancellation
  • BONUS_ISSUE - Bonus Issue/Capitalisation Issue
  • BONUS_ISSUE_CANCELLATION - Bonus Issue/Capitalisation Issue, Cancellation
  • CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities, Cancellation
  • CAPITAL_DISTRIBUTION - Capital distribution
  • CAPITAL_DISTRIBUTION_CANCELLATION - Capital distribution cancellation
  • CAPITAL_GAINS_DISTRIBUTION - Capital gains distribution
  • CAPITAL_GAINS_DISTRIBUTION_CANCELLATION - Capital gains distribution cancellation
  • CAPITALISATION - Capitalisation
  • CAPITALISATION_CANCELLATION - Capitalisation cancellation
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES - Cash distribution from non eligible securities sales
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION - Cash distribution from non eligible securities sales cancellation
  • CASH_DIVIDEND - Cash dividend
  • CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation
  • CHANGE - Change
  • CHANGE_CANCELLATION - Change, Cancellation
  • CLASS_ACTION - Class action
  • CLASS_ACTION_CANCELLATION - Class action cancellation
  • COMPANY_OPTION - Company option
  • COMPANY_OPTION_CANCELLATION - Company option cancellation
  • CONSENT - Consent
  • CONSENT_CANCELLATION - Consent cancellation
  • CONVERSION - Conversion
  • CONVERSION_CANCELLATION - Conversion cancellation
  • COURT_MEETING - Court meeting
  • COURT_MEETING_CANCELLATION - Court meeting cancellation
  • CREDIT_EVENT - Credit event
  • CREDIT_EVENT_CANCELLATION - Credit event cancellation
  • DECREASE_IN_VALUE - Decrease in value
  • DECREASE_IN_VALUE_CANCELLATION - Decrease in value cancellation
  • DETACHMENT - Detachment
  • DETACHMENT_CANCELLATION - Detachment cancellation
  • DISCLOSURE - Disclosure
  • DISCLOSURE_CANCELLATION - Disclosure cancellation
  • DIVIDEND_OPTION - Dividend Option
  • DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation
  • DIVIDEND_REINVESTMENT - Dividend Reinvestment
  • DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation
  • DRAWING - Drawing
  • DRAWING_CANCELLATION - Drawing cancellation
  • DUST_CLEANUP - Dust Cleanup
  • DUTCH_AUCTION - Dutch Auction
  • DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation
  • EXCHANGE - Exchange
  • EXCHANGE_CANCELLATION - Exchange cancellation
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING - Extraordinary or special general meeting
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION - Extraordinary or special general meeting cancellation
  • FINAL_MATURITY - Final maturity
  • FINAL_MATURITY_CANCELLATION - Final maturity cancellation
  • FULL_CALL - Full call
  • FULL_CALL_CANCELLATION - Full call cancellation
  • INCREASE_IN_VALUE - Increase in value
  • INCREASE_IN_VALUE_CANCELLATION - Increase in value cancellation
  • INFORMATION - Information
  • INFORMATION_CANCELLATION - Information cancellation
  • INSTALMENT_CALL - Instalment call
  • INSTALMENT_CALL_CANCELLATION - Instalment call cancellation
  • INTEREST_PAYMENT - Interest payment
  • INTEREST_PAYMENT_CANCELLATION - Interest payment cancellation
  • INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation
  • LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment
  • LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation
  • MATURITY_EXTENSION - Maturity extension
  • MATURITY_EXTENSION_CANCELLATION - Maturity extension cancellation
  • MERGER - Merger
  • MERGER_CANCELLATION - Merger, Cancellation
  • NON_OFFICIAL_OFFER - Non-Official Offer
  • NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, Cancellation
  • NON_US_TEFRA_D_CERTIFICATION - Non us tefra d certification
  • NON_US_TEFRA_D_CERTIFICATION_CANCELLATION - Non us tefra d certification cancellation
  • ODD_LOT_SALE - Odd Lot Sale/Purchase
  • ODD_LOT_SALE_CANCELLATION - Odd Lot Sale/Purchase, Cancellation
  • ORDER_EXECUTION - Order execution
  • ORDER_EXECUTION_CANCELLATION - Order execution cancellation
  • ORDINARY_GENERAL_MEETING - Ordinary general meeting
  • ORDINARY_GENERAL_MEETING_CANCELLATION - Ordinary general meeting cancellation
  • OTHER_EVENT - Other Event
  • OTHER_EVENT_CANCELLATION - Other Event cancellation
  • PARI_PASSU - Pari passu
  • PARI_PASSU_CANCELLATION - Pari passu cancellation
  • PARTIAL_DEFEASANCE - Partial defeasance
  • PARTIAL_DEFEASANCE_CANCELLATION - Partial defeasance cancellation
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION - Partial redemption with pool factor reduction
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption with pool factor reduction cancellation
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION - Partial redemption without pool factor reduction
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption without pool factor reduction cancellation
  • PAY_IN_KIND - Pay in kind
  • PAY_IN_KIND_CANCELLATION - Pay in kind cancellation
  • PEAK_FRACTION_COMPENSATION - Peak fraction compensation
  • PEAK_ORDER_ADJUSTMENT - Peak order adjustment
  • PLACE_OF_INCORPORATION - Place of incorporation
  • PLACE_OF_INCORPORATION_CANCELLATION - Place of incorporation cancellation
  • PRIORITY_ISSUE - Priority Issue
  • PRIORITY_ISSUE_CANCELLATION - Priority Issue, Cancellation
  • PUT_REDEMPTION - Put redemption
  • PUT_REDEMPTION_CANCELLATION - Put redemption cancellation
  • REDENOMINATION - Redenomination
  • REDENOMINATION_CANCELLATION - Redenomination cancellation
  • REMARKETING_AGREEMENT - Remarketing agreement
  • REMARKETING_AGREEMENT_CANCELLATION - Remarketing agreement cancellation
  • REPURCHASE_OFFER - Repurchase Offer/Issuer Bid/Reverse Rights
  • REPURCHASE_OFFER_CANCELLATION - Repurchase Offer/Issuer Bid/Reverse Rights, Cancellation
  • REVERSE_STOCK_SPLIT - Reverse Stock Split/Change in Nominal Value
  • REVERSE_STOCK_SPLIT_CANCELLATION - Reverse Stock Split/Change in Nominal Value, Cancellation
  • RIGHTS_ISSUE - Rights Issue/Subscription Rights/Rights Offer
  • RIGHTS_ISSUE_CANCELLATION - Rights Issue/Subscription Rights/Rights Offer, Cancellation
  • SCRIP_DIVIDEND - Scrip dividend
  • SCRIP_DIVIDEND_CANCELLATION - Scrip dividend cancellation
  • SECURITIES_TRANSFER - Securities transfer
  • SECURITIES_TRANSFER_CANCELLATION - Securities transfer cancellation
  • SHARES_PREMIUM_DIVIDEND - Shares premium dividend
  • SHARES_PREMIUM_DIVIDEND_CANCELLATION - Shares premium dividend cancellation
  • SMALLEST_NEGOTIABLE_UNIT - Smallest negotiable unit
  • SMALLEST_NEGOTIABLE_UNIT_CANCELLATION - Smallest negotiable unit cancellation
  • SPIN_OFF - Spin-Off
  • SPIN_OFF_CANCELLATION - Spin-Off, Cancellation
  • STOCK_DIVIDEND - Stock Dividend
  • STOCK_DIVIDEND_CANCELLATION - Stock Dividend, Cancellation
  • STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision
  • STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS - Tax on non distributed proceeds
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION - Tax on non distributed proceeds cancellation
  • TAX_OPTIMISATION - Tax optimisation
  • TAX_RECLAIM - Tax reclaim
  • TAX_RECLAIM_CANCELLATION - Tax reclaim cancellation
  • TENDER - Tender/Acquisition/Takeover/Purchase Offer
  • TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation
  • TRADING_STATUS_ACTIVE - Trading status active
  • TRADING_STATUS_ACTIVE_CANCELLATION - Trading status active cancellation
  • TRADING_STATUS_DELISTED - Trading status delisted
  • TRADING_STATUS_DELISTED_CANCELLATION - Trading status delisted cancellation
  • TRADING_STATUS_SUSPENDED - Trading status suspended
  • TRADING_STATUS_SUSPENDED_CANCELLATION - Trading status suspended cancellation
  • VIRTUAL_CASH_CORRECTION_CANCELLATION - Virtual cash correction cancellation
  • WARRANT_EXERCISE - Warrant exercise
  • WARRANT_EXERCISE_CANCELLATION - Warrant exercise cancellation
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION - Withholding tax relief certification
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION - Withholding tax relief certification cancellation
  • WORTHLESS - Worthless
  • WORTHLESS_CANCELLATION - Worthless, Cancellation
Enum"ACCUMULATION""ACCUMULATION_CANCELLATION""ANNUAL_GENERAL_MEETING""ANNUAL_GENERAL_MEETING_CANCELLATION""ATTACHMENT""ATTACHMENT_CANCELLATION""BALANCE_CORRECTION""BALANCE_CORRECTION_CANCELLATION""BANKRUPTCY""BANKRUPTCY_CANCELLATION"
account_idstring(uuid)required

Account unique identifier.

account_group_idstring(uuid)required

Account group unique identifier.

instrumentobjectrequired

Entity representing instrument.

uuidstring(uuid)required

Internal instrument identifier.

isinstring^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

deltaobjectrequired

Entity representing the security transaction delta.

amountstring^-?[0-9]{0,63}(\.[0-9]{1,27})?$required
property name*anyadditional property
referencesArray of objectsrequired
idstring(uuid)required

Unique identifier for a resource of given type.

typestringrequired

Type of the reference.

  • ORDER - Order
  • ORDER_EXECUTION - Order execution
  • CORPORATE_ACTION - Corporate action
  • CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction ID
Enum"ORDER""ORDER_EXECUTION""CORPORATE_ACTION""CORPORATE_ACTION_TRANSACTION_ID"
value_datestring(date-time)required

Transaction value date and time. RFC 3339-5, ISO8601 UTC

booking_datestring(date-time)required

Transaction booking date and time. RFC 3339-5, ISO8601 UTC

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

property name*anyadditional property
webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "543c9996-eff6-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00.000Z",
  "type": "SECURITY_TRANSACTION.EXECUTED",
  "object": {
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "created_at": "2023-01-01T00:00:00.000Z",
    "updated_at": "2023-01-01T00:00:00.000Z",
    "type": "ORDER_EXECUTION",
    "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "instrument": { … },
    "delta": { … },
    "references": [ … ],
    "booking_date": "2023-01-01T00:00:00.000Z",
    "value_date": "2023-01-01T00:00:00.000Z"
  },
  "webhook_id": "3ae8a8a4-eff6-11ed-a05b-0242ac120003"
}

Responses

Request has been processed successfully.

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations