API status
  • Reporting

Transactions

All transactions related paths.

get

List cash transactions

List cash transactions

account_group_idstring

Filters the list to show only transactions associated with a certain account group ID.

Format
uuid
Example
"413715f2-5401-4b97-8055-034a6b879f8c"
start_datestring

Returns transactions starting from and including this date (UTC).

Format
date
Example
"2023-01-03"
end_datestring

Returns transactions up until this date (UTC)

Format
date
Example
"2023-01-11"
sortstring

Sort the result by booking_date.

Default
"booking_date"
Enum
  • booking_date
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses

Response examples

Cash Transactions

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 2,
    "total_count": 2,
    "sort": "booking_date",
    "order": "ASC"
  },
  "data": [
    {
      "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_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "delta": {
        "amount": "-305.00",
        "currency": "EUR"
      },
      "taxes": [
        {
          "amount": "5.00",
          "currency": "EUR",
          "type": "TOTAL"
        }
      ],
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    },
    {
      "id": "9e7a3188-eff8-11ed-a05b-0242ac120003",
      "created_at": "2023-01-01T00:00:00.000Z",
      "updated_at": "2023-01-01T00:00:00.000Z",
      "type": "SEPA_DIRECT_DEBIT",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "delta": {
        "amount": "100.00",
        "currency": "EUR"
      },
      "taxes": [],
      "references": [
        {
          "id": "98f01200-eff8-11ed-a05b-0242ac120003",
          "type": "DIRECT_DEBIT"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    }
  ]
}
get

List securities transactions

List securities transactions

account_group_idstring

Filters the list to only show transactions associated with a certain account group ID.

Format
uuid
Example
"413715f2-5401-4b97-8055-034a6b879f8c"
account_idstring

Filters the list to only show transactions associated with a certain account ID.

Format
uuid
Example
"413715f2-5401-4b97-8055-034a6b879f8c"
start_datestring

Returns transactions starting from and including this date (UTC)

Format
date
Example
"2023-01-03"
end_datestring

Returns transactions up until this date (UTC)

Format
date
Example
"2023-01-11"
sortstring

Sort the result by booking_date.

Default
"booking_date"
Enum
  • booking_date
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses

Response examples

Securities Transactions

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 2,
    "total_count": 2,
    "sort": "booking_date",
    "order": "ASC"
  },
  "data": [
    {
      "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": {
        "isin": "US0378331005",
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
      },
      "delta": {
        "amount": "-2.5234543879"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    },
    {
      "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_CANCELLATION",
      "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "instrument": {
        "isin": "US0378331005",
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
      },
      "delta": {
        "amount": "2.5234543879"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    }
  ]
}
webhook

Cash transactions events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

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

Format
date-time
typestring

required

Event type

Default
"CASH_TRANSACTION.EXECUTED"
Enum
  • CASH_TRANSACTION.EXECUTED
objectobject (Cash Transaction)

required

account_group_idstring

required

Account group unique identifier.

Format
uuid
booking_datestring

required

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

Format
date-time
created_atstring

required

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

Format
date-time
deltaobject (Cash transaction delta)

required

Entity representing cash transaction delta.

idstring

required

Cash transaction unique identifier.

Format
uuid
instrumentobject (Instrument)

Entity representing instrument.

account_idstring

Account unique identifier.

Format
uuid
taxesarray

required

feesarray
referencesarray

required

typestring

required

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
  • INTERNAL_CASH_TRANSFER - Internal cash transfer
  • INTERNAL_CASH_TRANSFER_CANCELLATION - Internal cash transfer, Cancellation
  • ISA_TRANSFER - ISA transfer
  • 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
  • BOND_DEFAULT
  • BOND_DEFAULT_CANCELLATION
  • BOND_HOLDER_MEETING
  • BOND_HOLDER_MEETING_CANCELLATION
  • BONUS_ISSUE
  • BONUS_ISSUE_CANCELLATION
  • CALL_ON_INTERMEDIATE_SECURITIES
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION
  • CAPITAL_DISTRIBUTION
  • CAPITAL_DISTRIBUTION_CANCELLATION
  • CAPITAL_GAINS_DISTRIBUTION
  • CAPITAL_GAINS_DISTRIBUTION_CANCELLATION
  • CAPITALISATION
  • CAPITALISATION_CANCELLATION
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION
  • CASH_DIVIDEND
  • CASH_DIVIDEND_CANCELLATION
  • CHANGE
  • CHANGE_CANCELLATION
  • CLASS_ACTION
  • CLASS_ACTION_CANCELLATION
  • COMPANY_OPTION
  • COMPANY_OPTION_CANCELLATION
  • CONSENT
  • CONSENT_CANCELLATION
  • CONVERSION
  • CONVERSION_CANCELLATION
  • COURT_MEETING
  • COURT_MEETING_CANCELLATION
  • CREDIT_EVENT
  • CREDIT_EVENT_CANCELLATION
  • CREDIT_FUNDING
  • CREDIT_FUNDING_CHARGE_BACK
  • DD_REFUND_REJECT_FEE
  • DD_REFUND_REJECT_FEE_CANCELLATION
  • DECREASE_IN_VALUE
  • DECREASE_IN_VALUE_CANCELLATION
  • DETACHMENT
  • DETACHMENT_CANCELLATION
  • DISCLOSURE
  • DISCLOSURE_CANCELLATION
  • DIVIDEND_OPTION
  • DIVIDEND_OPTION_CANCELLATION
  • DIVIDEND_REINVESTMENT
  • DIVIDEND_REINVESTMENT_CANCELLATION
  • DRAWING
  • DRAWING_CANCELLATION
  • DUTCH_AUCTION
  • DUTCH_AUCTION_CANCELLATION
  • EXCHANGE
  • EXCHANGE_CANCELLATION
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION
  • FEE_COLLECTION
  • FEE_COLLECTION_CANCELLATION
  • FINAL_MATURITY
  • FINAL_MATURITY_CANCELLATION
  • FULL_CALL
  • FULL_CALL_CANCELLATION
  • INCREASE_IN_VALUE
  • INCREASE_IN_VALUE_CANCELLATION
  • INFORMATION
  • INFORMATION_CANCELLATION
  • INSTALMENT_CALL
  • INSTALMENT_CALL_CANCELLATION
  • INTEREST_PAYMENT
  • INTEREST_PAYMENT_CANCELLATION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION
  • INTERNAL_CASH_TRANSFER
  • INTERNAL_CASH_TRANSFER_CANCELLATION
  • ISA_TRANSFER
  • LIQUIDATION_PAYMENT
  • LIQUIDATION_PAYMENT_CANCELLATION
  • MATURITY_EXTENSION
  • MATURITY_EXTENSION_CANCELLATION
  • MERGER
  • MERGER_CANCELLATION
  • NON_OFFICIAL_OFFER
  • NON_OFFICIAL_OFFER_CANCELLATION
  • NON_US_TEFRA_D_CERTIFICATION
  • NON_US_TEFRA_D_CERTIFICATION_CANCELLATION
  • ODD_LOT_SALE
  • ODD_LOT_SALE_CANCELLATION
  • ORDER_EXECUTION
  • ORDER_EXECUTION_CANCELLATION
  • ORDINARY_GENERAL_MEETING
  • ORDINARY_GENERAL_MEETING_CANCELLATION
  • OTHER_EVENT
  • OTHER_EVENT_CANCELLATION
  • PARI_PASSU
  • PARI_PASSU_CANCELLATION
  • PARTIAL_DEFEASANCE
  • PARTIAL_DEFEASANCE_CANCELLATION
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION
  • PAY_IN_KIND
  • PAY_IN_KIND_CANCELLATION
  • PEAK_FRACTION_COMPENSATION
  • PEAK_ORDER_ADJUSTMENT
  • PLACE_OF_INCORPORATION
  • PLACE_OF_INCORPORATION_CANCELLATION
  • PRIORITY_ISSUE
  • PRIORITY_ISSUE_CANCELLATION
  • PUT_REDEMPTION
  • PUT_REDEMPTION_CANCELLATION
  • REDENOMINATION
  • REDENOMINATION_CANCELLATION
  • REMARKETING_AGREEMENT
  • REMARKETING_AGREEMENT_CANCELLATION
  • REPURCHASE_OFFER
  • REPURCHASE_OFFER_CANCELLATION
  • REVERSE_STOCK_SPLIT
  • REVERSE_STOCK_SPLIT_CANCELLATION
  • RIGHTS_ISSUE
  • RIGHTS_ISSUE_CANCELLATION
  • SCRIP_DIVIDEND
  • SCRIP_DIVIDEND_CANCELLATION
  • SEPA_DIRECT_DEBIT
  • SEPA_DIRECT_DEBIT_CHARGE_BACK
  • SHARES_PREMIUM_DIVIDEND
  • SHARES_PREMIUM_DIVIDEND_CANCELLATION
  • SMALLEST_NEGOTIABLE_UNIT
  • SMALLEST_NEGOTIABLE_UNIT_CANCELLATION
  • SPIN_OFF
  • SPIN_OFF_CANCELLATION
  • STOCK_DIVIDEND
  • STOCK_DIVIDEND_CANCELLATION
  • STOCK_SPLIT
  • STOCK_SPLIT_CANCELLATION
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION
  • TAX_OPTIMISATION
  • TAX_PAYMENT
  • TAX_PREPAYMENT_DE
  • TAX_RECLAIM
  • TAX_RECLAIM_CANCELLATION
  • TAX_REFUND
  • TENDER
  • TENDER_CANCELLATION
  • TOPUP
  • TOPUP_CANCELLATION
  • TRADING_STATUS_ACTIVE
  • TRADING_STATUS_ACTIVE_CANCELLATION
  • TRADING_STATUS_DELISTED
  • TRADING_STATUS_DELISTED_CANCELLATION
  • TRADING_STATUS_SUSPENDED
  • TRADING_STATUS_SUSPENDED_CANCELLATION
  • TREASURY_PAYMENT
  • VIRTUAL_CASH_CORRECTION
  • VIRTUAL_CASH_CORRECTION_CANCELLATION
  • VIRTUAL_CASH_DECREASE
  • VIRTUAL_CASH_INCREASE
  • WARRANT_EXERCISE
  • WARRANT_EXERCISE_CANCELLATION
  • WITHDRAWAL
  • WITHDRAWAL_CANCELLATION
  • WORTHLESS
  • WORTHLESS_CANCELLATION
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION
updated_atstring

required

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

Format
date-time
value_datestring

required

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

Format
date-time
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "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": {
      "isin": "US0378331005",
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
    },
    "delta": {
      "amount": "25.00",
      "currency": "EUR"
    },
    "taxes": [
      {
        "amount": "2.00",
        "currency": "EUR",
        "type": "TOTAL"
      }
    ],
    "references": [
      {
        "id": "c29a9ee8-ed64-11ef-a2e4-2eabd0c03f8a",
        "type": "CORPORATE_ACTION"
      },
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "CORPORATE_ACTION_TRANSACTION_ID"
      }
    ],
    "booking_date": "2023-01-01T00:00:00.000Z",
    "value_date": "2023-01-01T00:00:00.000Z"
  },
  "webhook_id": "9d3ac2e0-effa-11ed-a05b-0242ac120003"
}

Response examples

Request has been processed successfully.

Empty response

webhook

Security transactions events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

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

Format
date-time
typestring

required

Event type

Default
"SECURITY_TRANSACTION.EXECUTED"
Enum
  • SECURITY_TRANSACTION.EXECUTED
objectobject (Security Transaction)

required

account_group_idstring

required

Account group unique identifier.

Format
uuid
account_idstring

required

Account unique identifier.

Format
uuid
booking_datestring

required

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

Format
date-time
created_atstring

required

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

Format
date-time
deltaobject (Security transaction delta)

required

Entity representing the security transaction delta.

idstring

required

Security transaction unique identifier.

Format
uuid
instrumentobject (Instrument)

required

Entity representing instrument.

typestring

required

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
  • SECURITIES_LENDING - Securities lending
Enum
  • ACCUMULATION
  • ACCUMULATION_CANCELLATION
  • ANNUAL_GENERAL_MEETING
  • ANNUAL_GENERAL_MEETING_CANCELLATION
  • ATTACHMENT
  • ATTACHMENT_CANCELLATION
  • BALANCE_CORRECTION
  • BALANCE_CORRECTION_CANCELLATION
  • BANKRUPTCY
  • BANKRUPTCY_CANCELLATION
  • BOND_DEFAULT
  • BOND_DEFAULT_CANCELLATION
  • BOND_HOLDER_MEETING
  • BOND_HOLDER_MEETING_CANCELLATION
  • BONUS_ISSUE
  • BONUS_ISSUE_CANCELLATION
  • CALL_ON_INTERMEDIATE_SECURITIES
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION
  • CAPITAL_DISTRIBUTION
  • CAPITAL_DISTRIBUTION_CANCELLATION
  • CAPITAL_GAINS_DISTRIBUTION
  • CAPITAL_GAINS_DISTRIBUTION_CANCELLATION
  • CAPITALISATION
  • CAPITALISATION_CANCELLATION
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES
  • CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION
  • CASH_DIVIDEND
  • CASH_DIVIDEND_CANCELLATION
  • CHANGE
  • CHANGE_CANCELLATION
  • CLASS_ACTION
  • CLASS_ACTION_CANCELLATION
  • COMPANY_OPTION
  • COMPANY_OPTION_CANCELLATION
  • CONSENT
  • CONSENT_CANCELLATION
  • CONVERSION
  • CONVERSION_CANCELLATION
  • COURT_MEETING
  • COURT_MEETING_CANCELLATION
  • CREDIT_EVENT
  • CREDIT_EVENT_CANCELLATION
  • DECREASE_IN_VALUE
  • DECREASE_IN_VALUE_CANCELLATION
  • DETACHMENT
  • DETACHMENT_CANCELLATION
  • DISCLOSURE
  • DISCLOSURE_CANCELLATION
  • DIVIDEND_OPTION
  • DIVIDEND_OPTION_CANCELLATION
  • DIVIDEND_REINVESTMENT
  • DIVIDEND_REINVESTMENT_CANCELLATION
  • DRAWING
  • DRAWING_CANCELLATION
  • DUST_CLEANUP
  • DUTCH_AUCTION
  • DUTCH_AUCTION_CANCELLATION
  • EXCHANGE
  • EXCHANGE_CANCELLATION
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING
  • EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION
  • FINAL_MATURITY
  • FINAL_MATURITY_CANCELLATION
  • FULL_CALL
  • FULL_CALL_CANCELLATION
  • INCREASE_IN_VALUE
  • INCREASE_IN_VALUE_CANCELLATION
  • INFORMATION
  • INFORMATION_CANCELLATION
  • INSTALMENT_CALL
  • INSTALMENT_CALL_CANCELLATION
  • INTEREST_PAYMENT
  • INTEREST_PAYMENT_CANCELLATION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION
  • LIQUIDATION_PAYMENT
  • LIQUIDATION_PAYMENT_CANCELLATION
  • MATURITY_EXTENSION
  • MATURITY_EXTENSION_CANCELLATION
  • MERGER
  • MERGER_CANCELLATION
  • NON_OFFICIAL_OFFER
  • NON_OFFICIAL_OFFER_CANCELLATION
  • NON_US_TEFRA_D_CERTIFICATION
  • NON_US_TEFRA_D_CERTIFICATION_CANCELLATION
  • ODD_LOT_SALE
  • ODD_LOT_SALE_CANCELLATION
  • ORDER_EXECUTION
  • ORDER_EXECUTION_CANCELLATION
  • ORDINARY_GENERAL_MEETING
  • ORDINARY_GENERAL_MEETING_CANCELLATION
  • OTHER_EVENT
  • OTHER_EVENT_CANCELLATION
  • PARI_PASSU
  • PARI_PASSU_CANCELLATION
  • PARTIAL_DEFEASANCE
  • PARTIAL_DEFEASANCE_CANCELLATION
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION
  • PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION
  • PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION
  • PAY_IN_KIND
  • PAY_IN_KIND_CANCELLATION
  • PEAK_FRACTION_COMPENSATION
  • PEAK_ORDER_ADJUSTMENT
  • PLACE_OF_INCORPORATION
  • PLACE_OF_INCORPORATION_CANCELLATION
  • PRIORITY_ISSUE
  • PRIORITY_ISSUE_CANCELLATION
  • PUT_REDEMPTION
  • PUT_REDEMPTION_CANCELLATION
  • REDENOMINATION
  • REDENOMINATION_CANCELLATION
  • REMARKETING_AGREEMENT
  • REMARKETING_AGREEMENT_CANCELLATION
  • REPURCHASE_OFFER
  • REPURCHASE_OFFER_CANCELLATION
  • REVERSE_STOCK_SPLIT
  • REVERSE_STOCK_SPLIT_CANCELLATION
  • RIGHTS_ISSUE
  • RIGHTS_ISSUE_CANCELLATION
  • SCRIP_DIVIDEND
  • SCRIP_DIVIDEND_CANCELLATION
  • SECURITIES_TRANSFER
  • SECURITIES_TRANSFER_CANCELLATION
  • SHARES_PREMIUM_DIVIDEND
  • SHARES_PREMIUM_DIVIDEND_CANCELLATION
  • SMALLEST_NEGOTIABLE_UNIT
  • SMALLEST_NEGOTIABLE_UNIT_CANCELLATION
  • SPIN_OFF
  • SPIN_OFF_CANCELLATION
  • STOCK_DIVIDEND
  • STOCK_DIVIDEND_CANCELLATION
  • STOCK_SPLIT
  • STOCK_SPLIT_CANCELLATION
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS
  • TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION
  • TAX_OPTIMISATION
  • TAX_RECLAIM
  • TAX_RECLAIM_CANCELLATION
  • TENDER
  • TENDER_CANCELLATION
  • TRADING_STATUS_ACTIVE
  • TRADING_STATUS_ACTIVE_CANCELLATION
  • TRADING_STATUS_DELISTED
  • TRADING_STATUS_DELISTED_CANCELLATION
  • TRADING_STATUS_SUSPENDED
  • TRADING_STATUS_SUSPENDED_CANCELLATION
  • VIRTUAL_CASH_CORRECTION_CANCELLATION
  • WARRANT_EXERCISE
  • WARRANT_EXERCISE_CANCELLATION
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION
  • WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION
  • WORTHLESS
  • WORTHLESS_CANCELLATION
  • SECURITIES_LENDING
referencesarray

required

updated_atstring

required

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

Format
date-time
value_datestring

required

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

Format
date-time
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "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": {
      "isin": "US0378331005",
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
    },
    "delta": {
      "amount": "-2.5234543879"
    },
    "references": [
      {
        "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
        "type": "ORDER_EXECUTION"
      },
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "ORDER"
      }
    ],
    "booking_date": "2023-01-01T00:00:00.000Z",
    "value_date": "2023-01-01T00:00:00.000Z"
  },
  "webhook_id": "3ae8a8a4-eff6-11ed-a05b-0242ac120003"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?