Corporate Actions

Get Corporate Actions

get

/corporate-actions/

Get Corporate Actions

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

cursorstringOptional

String value used for pagination

limitinteger · min: 1Optional

Maximum number of items to return

Default: 20

startCreatedOnstring · date-timeOptional

Display corporate actions created on or after this date

endCreatedOnstring · date-timeOptional

Display corporate actions created on or before this date

exDatestring · date-timeOptional

Display corporate actions with ex-date on or after this date

paymentDatestring · date-timeOptional

Display corporate actions with payment date on or after this date

recordDatestring · date-timeOptional

Display corporate actions with record date on or after this date

responseDeadlinestring · date-timeOptional

Display corporate actions with response deadline on or after this date

statusstring · enumOptional

Corporate action event status

Possible values:

corporateActionReferencestringOptional

Display corporate actions with this reference number (links MT564 and MT566 events for the same underlying action)

Responses

200

application/json

400

Bad Request

application/json

get/corporate-actions/

GET /corporate-actions/ HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "corporateActionId": "123e4567-e89b-12d3-a456-426614174000",
      "corporateActionEventType": "DVCA",
      "isin": "text",
      "status": "ANNOUNCED",
      "dates": {
        "exDate": "2026-07-16T04:24:33.595Z",
        "paymentDate": "2026-07-16T04:24:33.595Z",
        "effectiveDate": "2026-07-16T04:24:33.595Z",
        "recordDate": "2026-07-16T04:24:33.595Z",
        "responseDeadline": "2026-07-16T04:24:33.595Z",
        "createdOn": "2026-07-16T04:24:33.595Z",
        "modifiedOn": "2026-07-16T04:24:33.595Z"
      },
      "details": {
        "ratioFrom": 1,
        "grossAmountPerShare": 1,
        "ratioTo": 1,
        "quantitySuccessfullyTendered": 1,
        "corporateActionOptions": [
          {
            "tenderOption": "NONE",
            "isDefaultAction": true,
            "offeredPricePerShare": 10,
            "maximumCashAmount": 1500,
            "maximumQuantitySharesAccepted": 10,
            "creditedIsin": "DE0005140008",
            "exchangeRatio": 1.5,
            "caonCode": "001"
          }
        ]
      },
      "customer": {
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
        "corporateActionCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "eligibleQuantity": 1,
        "oldQuantity": 1,
        "newQuantity": 1,
        "ratioFrom": 1,
        "ratioTo": 1,
        "grossAmount": 1,
        "netAmount": 1,
        "submittedCorporateActionOptions": [
          {
            "tenderOption": "NONE",
            "submittedTenderQuantity": 10,
            "quantitySuccessfullyTendered": 1,
            "tenderedCashAmount": 1
          }
        ],
        "currency": "EUR",
        "createdOn": "2026-07-16T04:24:33.595Z",
        "modifiedOn": "2026-07-16T04:24:33.595Z"
      },
      "corporateActionReference": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Submit customer option for corporate action

post

/corporate-actions/{corporateActionId}/instructions

The endpoint is currently under development, and the structure may still change.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

corporateActionIdstring · uuidRequired

Id of corporate action

Header parameters

Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body

depositoryCustomerProductIdstring · uuidRequired

The identifier of the depository customer product instance

Responses

202

Accepted

400

Bad Request

application/json

404

Not Found

application/json

post/corporate-actions/{corporateActionId}/instructions

POST /corporate-actions/{corporateActionId}/instructions HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "depositoryCustomerProductId": "123e4567-e89b-12d3-a456-426614174000",
  "elections": [
    {
      "corporateActionOption": "NONE",
      "tenderedQuantity": 1
    }
  ]
}

No content

Get Corporate Actions by Customer

get

/corporate-actions/customers/{customerId}

Get Corporate Actions by Customer

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

customerIdstring · uuidRequired

Unique customer identification number in UUID format

Query parameters

cursorstringOptional

String value used for pagination

limitinteger · min: 1Optional

Maximum number of items to return

Default: 20

startCreatedOnstring · date-timeOptional

Display corporate actions created on or after this date

endCreatedOnstring · date-timeOptional

Display corporate actions created on or before this date

corporateActionReferencestringOptional

Display corporate actions with this reference number (links MT564 and MT566 events for the same underlying action)

exDatestring · date-timeOptional

Display corporate actions with ex-date on or after this date

paymentDatestring · date-timeOptional

Display corporate actions with payment date on or after this date

recordDatestring · date-timeOptional

Display corporate actions with record date on or after this date

responseDeadlinestring · date-timeOptional

Display corporate actions with response deadline on or after this date

statusstring · enumOptional

Corporate action event status

Possible values:

Responses

200

application/json

400

Bad Request

application/json

get/corporate-actions/customers/{customerId}

GET /corporate-actions/customers/{customerId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "corporateActionId": "123e4567-e89b-12d3-a456-426614174000",
      "corporateActionEventType": "DVCA",
      "isin": "text",
      "status": "ANNOUNCED",
      "dates": {
        "exDate": "2026-07-16T04:24:33.595Z",
        "paymentDate": "2026-07-16T04:24:33.595Z",
        "effectiveDate": "2026-07-16T04:24:33.595Z",
        "recordDate": "2026-07-16T04:24:33.595Z",
        "responseDeadline": "2026-07-16T04:24:33.595Z",
        "createdOn": "2026-07-16T04:24:33.595Z",
        "modifiedOn": "2026-07-16T04:24:33.595Z"
      },
      "details": {
        "ratioFrom": 1,
        "grossAmountPerShare": 1,
        "ratioTo": 1,
        "quantitySuccessfullyTendered": 1,
        "corporateActionOptions": [
          {
            "tenderOption": "NONE",
            "isDefaultAction": true,
            "offeredPricePerShare": 10,
            "maximumCashAmount": 1500,
            "maximumQuantitySharesAccepted": 10,
            "creditedIsin": "DE0005140008",
            "exchangeRatio": 1.5,
            "caonCode": "001"
          }
        ]
      },
      "customer": {
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
        "corporateActionCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "eligibleQuantity": 1,
        "oldQuantity": 1,
        "newQuantity": 1,
        "ratioFrom": 1,
        "ratioTo": 1,
        "grossAmount": 1,
        "netAmount": 1,
        "submittedCorporateActionOptions": [
          {
            "tenderOption": "NONE",
            "submittedTenderQuantity": 10,
            "quantitySuccessfullyTendered": 1,
            "tenderedCashAmount": 1
          }
        ],
        "currency": "EUR",
        "createdOn": "2026-07-16T04:24:33.595Z",
        "modifiedOn": "2026-07-16T04:24:33.595Z"
      },
      "corporateActionReference": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Last updated 3 months ago