Transactions

Download Spec

All transactions related paths.

List cash transactions

get /transactions/cash

List cash transactions

OAuth2 oauth-client-credentials

Required Scopes:

transactions:read

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices,
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • tests:admin · Testing related operations
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

account_group_id

string

uuid

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

Example
"413715f2-5401-4b97-8055-034a6b879f8c"

start_date

string

date

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

Example
"2023-01-03"

end_date

string

date

Returns transactions up until this date (UTC)

Example
"2023-01-11"

sort

string

Sort the result by booking_date.

Default
"booking_date"
Enum
  • booking_date

order

string

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

offset

int

i32

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

Min
0

limit

int

i32

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

Default
100
Min
0
Max
1000

Response

Examples Schema

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

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Method Not Allowed. The requested method is not allowed on the requested resource.

{
  "status": 405,
  "type": "method_not_allowed"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

The field that the list is sorted by.

order

string

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[object (Cash Transaction)]

required

Cash Transaction

object (Cash Transaction)

account_group_id

string

uuid

required

Account group unique identifier.

booking_date

string

date-time

required

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

created_at

string

date-time

required

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

delta

object (delta)

required

Entity representing cash transaction delta.

amount

string

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

required

currency

string

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

id

string

uuid

required

Cash transaction unique identifier.

instrument

object (instrument)

Entity representing instrument

uuid

string

uuid

required

Internal instrument identifier.

isin

string

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

International securities identification number defined by ISO 6166.

account_id

string

uuid

Account unique identifier.

taxes

array[object (Transaction tax)]

required

Transaction tax

object (Transaction tax)

Entity representing the transaction tax.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

type

string

required

Type of the tax.

  • TOTAL - Total taxes
Default
"TOTAL"
Enum
  • TOTAL

references

array[object (Cash transaction reference)]

required

Cash transaction reference

object (Cash transaction reference)

Entity representing cash transaction reference.

id

string

uuid

required

Unique identifier for a resource of given type.

type

string

required

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
  • TOPUP - Cash top up
  • 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
  • TOPUP
  • VIRTUAL_CASH_DECREASE
  • VIRTUAL_CASH_INCREASE
  • WITHDRAWAL

type

string

required

Transaction type

  • CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities, Cancellation
  • CASH_DIVIDEND - Cash dividend
  • CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation
  • CREDIT_FUNDING - Credit Funding
  • 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
  • DIVIDEND_OPTION - Dividend Option
  • DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation
  • DIVIDEND_REINVESTMENT - Dividend Reinvestment
  • DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation
  • DUTCH_AUCTION - Dutch Auction
  • DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation
  • FEE_COLLECTION - Fee collection
  • FEE_COLLECTION_CANCELLATION - Fee collection cancellation
  • INCREASE_IN_VALUE - Increase in Value
  • INCREASE_IN_VALUE_CANCELLATION - Increase in Value, Cancellation
  • LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment
  • LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation
  • MERGER - Merger
  • MERGER_CANCELLATION - Merger, Cancellation
  • NON_OFFICIAL_OFFER - Non-Official Offer
  • NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, 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
  • OTHER_EVENT - Other Event
  • OTHER_EVENT_CANCELLATION - Other Event, Cancellation
  • PRIORITY_ISSUE - Priority Issue
  • PRIORITY_ISSUE_CANCELLATION - Priority Issue, 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
  • SEPA_DIRECT_DEBIT - Sepa direct debit
  • SEPA_DIRECT_DEBIT_CHARGE_BACK - Sepa direct debit charge back
  • SPIN_OFF - Spin-Off
  • SPIN_OFF_CANCELLATION - Spin-Off, Cancellation
  • STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision
  • STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation
  • TAX_OPTIMISATION - Tax Optimisation
  • TAX_PAYMENT - Tax payment
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_REFUND - Tax refund
  • TENDER - Tender/Acquisition/Takeover/Purchase Offer
  • TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation
  • TOPUP - Cash top up
  • TREASURY_PAYMENT - Treasury payment
  • VIRTUAL_CASH_DECREASE - Virtual cash decreased
  • VIRTUAL_CASH_INCREASE - Virtual cash increased
  • WITHDRAWAL - Withdrawal
  • WITHDRAWAL_CANCELLATION - Withdrawal cancellation
Enum
  • CALL_ON_INTERMEDIATE_SECURITIES
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION
  • CASH_DIVIDEND
  • CASH_DIVIDEND_CANCELLATION
  • CREDIT_FUNDING
  • DD_REFUND_REJECT_FEE
  • DD_REFUND_REJECT_FEE_CANCELLATION
  • DECREASE_IN_VALUE
  • DECREASE_IN_VALUE_CANCELLATION
  • DIVIDEND_OPTION
  • DIVIDEND_OPTION_CANCELLATION
  • DIVIDEND_REINVESTMENT
  • DIVIDEND_REINVESTMENT_CANCELLATION
  • DUTCH_AUCTION
  • DUTCH_AUCTION_CANCELLATION
  • FEE_COLLECTION
  • FEE_COLLECTION_CANCELLATION
  • INCREASE_IN_VALUE
  • INCREASE_IN_VALUE_CANCELLATION
  • LIQUIDATION_PAYMENT
  • LIQUIDATION_PAYMENT_CANCELLATION
  • MERGER
  • MERGER_CANCELLATION
  • NON_OFFICIAL_OFFER
  • NON_OFFICIAL_OFFER_CANCELLATION
  • ODD_LOT_SALE
  • ODD_LOT_SALE_CANCELLATION
  • ORDER_EXECUTION
  • ORDER_EXECUTION_CANCELLATION
  • OTHER_EVENT
  • OTHER_EVENT_CANCELLATION
  • PRIORITY_ISSUE
  • PRIORITY_ISSUE_CANCELLATION
  • REPURCHASE_OFFER
  • REPURCHASE_OFFER_CANCELLATION
  • REVERSE_STOCK_SPLIT
  • REVERSE_STOCK_SPLIT_CANCELLATION
  • SEPA_DIRECT_DEBIT
  • SEPA_DIRECT_DEBIT_CHARGE_BACK
  • SPIN_OFF
  • SPIN_OFF_CANCELLATION
  • STOCK_SPLIT
  • STOCK_SPLIT_CANCELLATION
  • TAX_OPTIMISATION
  • TAX_PAYMENT
  • TAX_PREPAYMENT_DE
  • TAX_REFUND
  • TENDER
  • TENDER_CANCELLATION
  • TOPUP
  • TREASURY_PAYMENT
  • VIRTUAL_CASH_DECREASE
  • VIRTUAL_CASH_INCREASE
  • WITHDRAWAL
  • WITHDRAWAL_CANCELLATION

updated_at

string

date-time

required

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

value_date

string

date-time

required

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

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

List securities transactions

get /transactions/securities

List securities transactions

OAuth2 oauth-client-credentials

Required Scopes:

transactions:read

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices,
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • tests:admin · Testing related operations
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

account_group_id

string

uuid

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

Example
"413715f2-5401-4b97-8055-034a6b879f8c"

account_id

string

uuid

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

Example
"413715f2-5401-4b97-8055-034a6b879f8c"

start_date

string

date

Returns transactions starting from and including this date (UTC)

Example
"2023-01-03"

end_date

string

date

Returns transactions up until this date (UTC)

Example
"2023-01-11"

sort

string

Sort the result by booking_date.

Default
"booking_date"
Enum
  • booking_date

order

string

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

offset

int

i32

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

Min
0

limit

int

i32

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

Default
100
Min
0
Max
1000

Response

Examples Schema

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:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
      "booking_date": "2023-01-01T00:00:00Z",
      "delta": {
        "amount": "-2.5234543879"
      },
      "instrument": {
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
        "isin": "US0378331005"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "type": "ORDER_EXECUTION",
      "value_date": "2023-01-01T00:00:00Z"
    },
    {
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
      "booking_date": "2023-01-01T00:00:00Z",
      "created_at": "2023-01-01T00:00:00Z",
      "delta": {
        "amount": "2.5234543879"
      },
      "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
      "instrument": {
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
        "isin": "US0378331005"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "type": "ORDER_EXECUTION_CANCELLATION",
      "updated_at": "2023-01-01T00:00:00Z",
      "value_date": "2023-01-01T00:00:00Z"
    }
  ]
}

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Method Not Allowed. The requested method is not allowed on the requested resource.

{
  "status": 405,
  "type": "method_not_allowed"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

The field that the list is sorted by.

order

string

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[object (Security Transaction)]

required

Security Transaction

object (Security Transaction)

account_group_id

string

uuid

required

Account group unique identifier.

account_id

string

uuid

required

Account unique identifier.

booking_date

string

date-time

required

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

created_at

string

date-time

required

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

delta

object (delta)

required

Entity representing the security transaction delta.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

id

string

uuid

required

Security transaction unique identifier.

instrument

object (instrument)

required

Entity representing instrument

uuid

string

uuid

required

Internal instrument identifier.

isin

string

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

International securities identification number defined by ISO 6166.

type

string

required

Transaction type

  • 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
  • CHANGE - Change
  • CHANGE_CANCELLATION - Change, Cancellation
  • DIVIDEND_OPTION - Dividend Option
  • DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation
  • DIVIDEND_REINVESTMENT - Dividend Reinvestment
  • DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation
  • DUST_CLEANUP - Dust Cleanup
  • DUTCH_AUCTION - Dutch Auction
  • DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation
  • INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation
  • MERGER - Merger
  • MERGER_CANCELLATION - Merger, Cancellation
  • NON_OFFICIAL_OFFER - Non-Official Offer
  • NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, 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
  • OTHER_EVENT - Other Event
  • OTHER_EVENT_CANCELLATION - Other Event, Cancellation
  • PRIORITY_ISSUE - Priority Issue
  • PRIORITY_ISSUE_CANCELLATION - Priority Issue, 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
  • SECURITIES_TRANSFER - Securities transfer
  • 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
  • TENDER - Tender/Acquisition/Takeover/Purchase Offer
  • TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation
  • WORTHLESS - Worthless
  • WORTHLESS_CANCELLATION - Worthless, Cancellation
Enum
  • BONUS_ISSUE
  • BONUS_ISSUE_CANCELLATION
  • CALL_ON_INTERMEDIATE_SECURITIES
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION
  • CHANGE
  • CHANGE_CANCELLATION
  • DIVIDEND_OPTION
  • DIVIDEND_OPTION_CANCELLATION
  • DIVIDEND_REINVESTMENT
  • DIVIDEND_REINVESTMENT_CANCELLATION
  • DUST_CLEANUP
  • DUTCH_AUCTION
  • DUTCH_AUCTION_CANCELLATION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION
  • MERGER
  • MERGER_CANCELLATION
  • NON_OFFICIAL_OFFER
  • NON_OFFICIAL_OFFER_CANCELLATION
  • ODD_LOT_SALE
  • ODD_LOT_SALE_CANCELLATION
  • ORDER_EXECUTION
  • ORDER_EXECUTION_CANCELLATION
  • OTHER_EVENT
  • OTHER_EVENT_CANCELLATION
  • PRIORITY_ISSUE
  • PRIORITY_ISSUE_CANCELLATION
  • REPURCHASE_OFFER
  • REPURCHASE_OFFER_CANCELLATION
  • REVERSE_STOCK_SPLIT
  • REVERSE_STOCK_SPLIT_CANCELLATION
  • RIGHTS_ISSUE
  • RIGHTS_ISSUE_CANCELLATION
  • SECURITIES_TRANSFER
  • SPIN_OFF
  • SPIN_OFF_CANCELLATION
  • STOCK_DIVIDEND
  • STOCK_DIVIDEND_CANCELLATION
  • STOCK_SPLIT
  • STOCK_SPLIT_CANCELLATION
  • TENDER
  • TENDER_CANCELLATION
  • WORTHLESS
  • WORTHLESS_CANCELLATION

references

array[object (Security transaction reference)]

required

Security transaction reference

object (Security transaction reference)

Entity representing security transaction reference

id

string

uuid

required

Unique identifier for a resource of given type.

type

string

required

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

updated_at

string

date-time

required

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

value_date

string

date-time

required

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

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Cash transactions events

webhook

Cash transactions events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Default
"CASH_TRANSACTION.EXECUTED"
Enum
  • CASH_TRANSACTION.EXECUTED

object

object (object)

required

account_group_id

string

uuid

required

Account group unique identifier.

booking_date

string

date-time

required

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

created_at

string

date-time

required

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

delta

object (delta)

required

Entity representing cash transaction delta.

amount

string

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

required

currency

string

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

id

string

uuid

required

Cash transaction unique identifier.

instrument

object (instrument)

Entity representing instrument

uuid

string

uuid

required

Internal instrument identifier.

isin

string

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

International securities identification number defined by ISO 6166.

account_id

string

uuid

Account unique identifier.

taxes

array[object (Transaction tax)]

required

Transaction tax

object (Transaction tax)

Entity representing the transaction tax.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

type

string

required

Type of the tax.

  • TOTAL - Total taxes
Default
"TOTAL"
Enum
  • TOTAL

references

array[object (Cash transaction reference)]

required

Cash transaction reference

object (Cash transaction reference)

Entity representing cash transaction reference.

id

string

uuid

required

Unique identifier for a resource of given type.

type

string

required

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
  • TOPUP - Cash top up
  • 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
  • TOPUP
  • VIRTUAL_CASH_DECREASE
  • VIRTUAL_CASH_INCREASE
  • WITHDRAWAL

type

string

required

Transaction type

  • CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities, Cancellation
  • CASH_DIVIDEND - Cash dividend
  • CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation
  • CREDIT_FUNDING - Credit Funding
  • 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
  • DIVIDEND_OPTION - Dividend Option
  • DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation
  • DIVIDEND_REINVESTMENT - Dividend Reinvestment
  • DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation
  • DUTCH_AUCTION - Dutch Auction
  • DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation
  • FEE_COLLECTION - Fee collection
  • FEE_COLLECTION_CANCELLATION - Fee collection cancellation
  • INCREASE_IN_VALUE - Increase in Value
  • INCREASE_IN_VALUE_CANCELLATION - Increase in Value, Cancellation
  • LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment
  • LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation
  • MERGER - Merger
  • MERGER_CANCELLATION - Merger, Cancellation
  • NON_OFFICIAL_OFFER - Non-Official Offer
  • NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, 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
  • OTHER_EVENT - Other Event
  • OTHER_EVENT_CANCELLATION - Other Event, Cancellation
  • PRIORITY_ISSUE - Priority Issue
  • PRIORITY_ISSUE_CANCELLATION - Priority Issue, 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
  • SEPA_DIRECT_DEBIT - Sepa direct debit
  • SEPA_DIRECT_DEBIT_CHARGE_BACK - Sepa direct debit charge back
  • SPIN_OFF - Spin-Off
  • SPIN_OFF_CANCELLATION - Spin-Off, Cancellation
  • STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision
  • STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation
  • TAX_OPTIMISATION - Tax Optimisation
  • TAX_PAYMENT - Tax payment
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_REFUND - Tax refund
  • TENDER - Tender/Acquisition/Takeover/Purchase Offer
  • TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation
  • TOPUP - Cash top up
  • TREASURY_PAYMENT - Treasury payment
  • VIRTUAL_CASH_DECREASE - Virtual cash decreased
  • VIRTUAL_CASH_INCREASE - Virtual cash increased
  • WITHDRAWAL - Withdrawal
  • WITHDRAWAL_CANCELLATION - Withdrawal cancellation
Enum
  • CALL_ON_INTERMEDIATE_SECURITIES
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION
  • CASH_DIVIDEND
  • CASH_DIVIDEND_CANCELLATION
  • CREDIT_FUNDING
  • DD_REFUND_REJECT_FEE
  • DD_REFUND_REJECT_FEE_CANCELLATION
  • DECREASE_IN_VALUE
  • DECREASE_IN_VALUE_CANCELLATION
  • DIVIDEND_OPTION
  • DIVIDEND_OPTION_CANCELLATION
  • DIVIDEND_REINVESTMENT
  • DIVIDEND_REINVESTMENT_CANCELLATION
  • DUTCH_AUCTION
  • DUTCH_AUCTION_CANCELLATION
  • FEE_COLLECTION
  • FEE_COLLECTION_CANCELLATION
  • INCREASE_IN_VALUE
  • INCREASE_IN_VALUE_CANCELLATION
  • LIQUIDATION_PAYMENT
  • LIQUIDATION_PAYMENT_CANCELLATION
  • MERGER
  • MERGER_CANCELLATION
  • NON_OFFICIAL_OFFER
  • NON_OFFICIAL_OFFER_CANCELLATION
  • ODD_LOT_SALE
  • ODD_LOT_SALE_CANCELLATION
  • ORDER_EXECUTION
  • ORDER_EXECUTION_CANCELLATION
  • OTHER_EVENT
  • OTHER_EVENT_CANCELLATION
  • PRIORITY_ISSUE
  • PRIORITY_ISSUE_CANCELLATION
  • REPURCHASE_OFFER
  • REPURCHASE_OFFER_CANCELLATION
  • REVERSE_STOCK_SPLIT
  • REVERSE_STOCK_SPLIT_CANCELLATION
  • SEPA_DIRECT_DEBIT
  • SEPA_DIRECT_DEBIT_CHARGE_BACK
  • SPIN_OFF
  • SPIN_OFF_CANCELLATION
  • STOCK_SPLIT
  • STOCK_SPLIT_CANCELLATION
  • TAX_OPTIMISATION
  • TAX_PAYMENT
  • TAX_PREPAYMENT_DE
  • TAX_REFUND
  • TENDER
  • TENDER_CANCELLATION
  • TOPUP
  • TREASURY_PAYMENT
  • VIRTUAL_CASH_DECREASE
  • VIRTUAL_CASH_INCREASE
  • WITHDRAWAL
  • WITHDRAWAL_CANCELLATION

updated_at

string

date-time

required

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

value_date

string

date-time

required

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

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "id": "55a877ce-effa-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "account_id": "0255e6c4-effa-11ed-a05b-0242ac120003",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "25.00",
      "currency": "EUR"
    },
    "instrument": {
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
      "isin": "US0378331005"
    },
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "references": [
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "CORPORATE_ACTION_TRANSACTION_ID"
      }
    ],
    "taxes": [
      {
        "amount": "2.00",
        "currency": "EUR",
        "type": "TOTAL"
      }
    ],
    "type": "CASH_DIVIDEND",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "9d3ac2e0-effa-11ed-a05b-0242ac120003"
}
{
  "id": "e23218bc-effa-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "account_id": "0255e6c4-effa-11ed-a05b-0242ac120003",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "-25.00",
      "currency": "EUR"
    },
    "instrument": {
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
      "isin": "US0378331005"
    },
    "id": "dafd9954-effa-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "CORPORATE_ACTION_TRANSACTION_ID"
      }
    ],
    "taxes": [
      {
        "amount": "2.00",
        "currency": "EUR",
        "type": "TOTAL"
      }
    ],
    "type": "CASH_DIVIDEND_CANCELLATION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "d68273ae-effa-11ed-a05b-0242ac120003"
}
{
  "id": "398278e2-8835-11ed-97e3-2eabd0c03f8a",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "250",
      "currency": "EUR"
    },
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "references": [
      {
        "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
        "type": "ORDER_EXECUTION"
      },
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "ORDER"
      }
    ],
    "taxes": [
      {
        "amount": "20",
        "currency": "EUR",
        "type": "TOTAL"
      }
    ],
    "type": "ORDER_EXECUTION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "35701970-effb-11ed-a05b-0242ac120003"
}
{
  "id": "1dac4156-effb-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "-250",
      "currency": "EUR"
    },
    "id": "25c56ab6-effb-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
        "type": "ORDER_EXECUTION"
      },
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "ORDER"
      }
    ],
    "taxes": [
      {
        "amount": "20.00",
        "currency": "EUR",
        "type": "TOTAL"
      }
    ],
    "type": "ORDER_EXECUTION_CANCELLATION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "162db946-effb-11ed-a05b-0242ac120003"
}
{
  "id": "1d27576e-f4a3-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "-10.00",
      "currency": "EUR"
    },
    "id": "2349857c-f4a3-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "17c36d9e-f4a3-11ed-a05b-0242ac120003",
        "type": "FEE_COLLECTION"
      }
    ],
    "taxes": [],
    "type": "FEE_COLLECTION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "1216067c-f4a3-11ed-a05b-0242ac120003"
}
{
  "id": "3cdfad72-f4a3-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "10.00",
      "currency": "EUR"
    },
    "id": "2349857c-f4a3-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "45d15c46-f4a3-11ed-a05b-0242ac120003",
        "type": "FEE_COLLECTION"
      }
    ],
    "taxes": [],
    "type": "FEE_COLLECTION_CANCELLATION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "40fb1252-f4a3-11ed-a05b-0242ac120003"
}
{
  "id": "a9a76224-eff8-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "100.00",
      "currency": "EUR"
    },
    "id": "9e7a3188-eff8-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "98f01200-eff8-11ed-a05b-0242ac120003",
        "type": "DIRECT_DEBIT"
      }
    ],
    "taxes": [],
    "type": "SEPA_DIRECT_DEBIT",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "9390c822-eff8-11ed-a05b-0242ac120003"
}
{
  "id": "2e471146-eff9-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "-305.00",
      "currency": "EUR"
    },
    "id": "23547364-eff9-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "1d2a347e-eff9-11ed-a05b-0242ac120003",
        "type": "DIRECT_DEBIT"
      }
    ],
    "taxes": [],
    "type": "SEPA_DIRECT_DEBIT_CHARGE_BACK",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "060844b6-eff9-11ed-a05b-0242ac120003"
}
{
  "id": "e619bf74-effb-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "100",
      "currency": "EUR"
    },
    "id": "e165c4b4-effb-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "dbf4d0a6-effb-11ed-a05b-0242ac120003",
        "type": "TOPUP"
      }
    ],
    "taxes": [],
    "type": "TOPUP",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "d53b06f4-effb-11ed-a05b-0242ac120003"
}
{
  "id": "398278e2-8835-11ed-97e3-2eabd0c03f8a",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "-305.00",
      "currency": "EUR"
    },
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "references": [
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "WITHDRAWAL"
      }
    ],
    "taxes": [],
    "type": "WITHDRAWAL",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "7eea34e2-8835-11ed-a47e-2eabd0c03f8a"
}
{
  "id": "10cabec6-effc-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "305.00",
      "currency": "EUR"
    },
    "id": "15750eae-effc-11ed-a05b-0242ac120003",
    "references": [
      {
        "id": "1cffa512-effc-11ed-a05b-0242ac120003",
        "type": "WITHDRAWAL"
      }
    ],
    "taxes": [],
    "type": "WITHDRAWAL_CANCELLATION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "0d0edd62-effc-11ed-a05b-0242ac120003"
}

Response

Examples Schema

Request has been processed successfully.

Empty response

No schema

Security transactions events

webhook

Security transactions events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Default
"SECURITY_TRANSACTION.EXECUTED"
Enum
  • SECURITY_TRANSACTION.EXECUTED

object

object (object)

required

account_group_id

string

uuid

required

Account group unique identifier.

account_id

string

uuid

required

Account unique identifier.

booking_date

string

date-time

required

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

created_at

string

date-time

required

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

delta

object (delta)

required

Entity representing the security transaction delta.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

id

string

uuid

required

Security transaction unique identifier.

instrument

object (instrument)

required

Entity representing instrument

uuid

string

uuid

required

Internal instrument identifier.

isin

string

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

International securities identification number defined by ISO 6166.

type

string

required

Transaction type

  • 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
  • CHANGE - Change
  • CHANGE_CANCELLATION - Change, Cancellation
  • DIVIDEND_OPTION - Dividend Option
  • DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation
  • DIVIDEND_REINVESTMENT - Dividend Reinvestment
  • DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation
  • DUST_CLEANUP - Dust Cleanup
  • DUTCH_AUCTION - Dutch Auction
  • DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation
  • INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation
  • MERGER - Merger
  • MERGER_CANCELLATION - Merger, Cancellation
  • NON_OFFICIAL_OFFER - Non-Official Offer
  • NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, 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
  • OTHER_EVENT - Other Event
  • OTHER_EVENT_CANCELLATION - Other Event, Cancellation
  • PRIORITY_ISSUE - Priority Issue
  • PRIORITY_ISSUE_CANCELLATION - Priority Issue, 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
  • SECURITIES_TRANSFER - Securities transfer
  • 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
  • TENDER - Tender/Acquisition/Takeover/Purchase Offer
  • TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation
  • WORTHLESS - Worthless
  • WORTHLESS_CANCELLATION - Worthless, Cancellation
Enum
  • BONUS_ISSUE
  • BONUS_ISSUE_CANCELLATION
  • CALL_ON_INTERMEDIATE_SECURITIES
  • CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION
  • CHANGE
  • CHANGE_CANCELLATION
  • DIVIDEND_OPTION
  • DIVIDEND_OPTION_CANCELLATION
  • DIVIDEND_REINVESTMENT
  • DIVIDEND_REINVESTMENT_CANCELLATION
  • DUST_CLEANUP
  • DUTCH_AUCTION
  • DUTCH_AUCTION_CANCELLATION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION
  • INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION
  • MERGER
  • MERGER_CANCELLATION
  • NON_OFFICIAL_OFFER
  • NON_OFFICIAL_OFFER_CANCELLATION
  • ODD_LOT_SALE
  • ODD_LOT_SALE_CANCELLATION
  • ORDER_EXECUTION
  • ORDER_EXECUTION_CANCELLATION
  • OTHER_EVENT
  • OTHER_EVENT_CANCELLATION
  • PRIORITY_ISSUE
  • PRIORITY_ISSUE_CANCELLATION
  • REPURCHASE_OFFER
  • REPURCHASE_OFFER_CANCELLATION
  • REVERSE_STOCK_SPLIT
  • REVERSE_STOCK_SPLIT_CANCELLATION
  • RIGHTS_ISSUE
  • RIGHTS_ISSUE_CANCELLATION
  • SECURITIES_TRANSFER
  • SPIN_OFF
  • SPIN_OFF_CANCELLATION
  • STOCK_DIVIDEND
  • STOCK_DIVIDEND_CANCELLATION
  • STOCK_SPLIT
  • STOCK_SPLIT_CANCELLATION
  • TENDER
  • TENDER_CANCELLATION
  • WORTHLESS
  • WORTHLESS_CANCELLATION

references

array[object (Security transaction reference)]

required

Security transaction reference

object (Security transaction reference)

Entity representing security transaction reference

id

string

uuid

required

Unique identifier for a resource of given type.

type

string

required

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

updated_at

string

date-time

required

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

value_date

string

date-time

required

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

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "id": "543c9996-eff6-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "SECURITY_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "-2.5234543879"
    },
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "instrument": {
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
      "isin": "US0378331005"
    },
    "references": [
      {
        "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
        "type": "ORDER_EXECUTION"
      },
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "ORDER"
      }
    ],
    "type": "ORDER_EXECUTION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "3ae8a8a4-eff6-11ed-a05b-0242ac120003"
}
{
  "id": "398278e2-8835-11ed-97e3-2eabd0c03f8a",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "SECURITY_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "2.50"
    },
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "instrument": {
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
      "isin": "US0378331005"
    },
    "references": [
      {
        "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
        "type": "ORDER_EXECUTION"
      },
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "ORDER"
      }
    ],
    "type": "ORDER_EXECUTION_CANCELLATION",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "fd9690e2-effa-11ed-a05b-0242ac120003"
}
{
  "id": "71478127-4688-46b6-b3c6-871febb20330",
  "created_at": "2023-01-01T00:00:00Z",
  "type": "SECURITY_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
    "booking_date": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "delta": {
      "amount": "32.52"
    },
    "id": "f0f6834a-ddc8-4ef4-b4e2-025a6bbd1cf1",
    "instrument": {
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
      "isin": "US0378331005"
    },
    "references": [
      {
        "id": "7f3a087b-2934-40f0-a311-caab2e449d9b",
        "type": "CORPORATE_ACTION"
      },
      {
        "id": "f29af46d-d424-4b87-b656-ab2cb46e460c",
        "type": "CORPORATE_ACTION_TRANSACTION_ID"
      }
    ],
    "type": "MERGER",
    "updated_at": "2023-01-01T00:00:00Z",
    "value_date": "2023-01-01T00:00:00Z"
  },
  "webhook_id": "52a47a86-8805-43be-b631-d79e67bb5da9"
}

Response

Examples Schema

Request has been processed successfully.

Empty response

No schema

Was this page helpful?