AM/TA - Cancel Capital Event

You can cancel a capital event before launch.

Details

/external/v1/capital-events/{capitalEventId}/cancel

Synopsis

Cancel Capital Event

put

This route is used to trigger the cancellation of the capital event (capital call or distribution). This is an irreversible action that can be called if the event is in draft state. The typical use case for this endpoint is to cancel an event that was created by mistake. It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints. This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"]. This endpoint can be invoked if the capital event is in one of the following statuses: ["draft"] This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"]. This endpoint can be called by applications with access to scope "manageCapitalEvent".

Required scopes

This endpoint requires the following scopes:

• : manageCapitalEvent

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

capitalEventIdanyRequired

The id that uniquely identifies the capital event on the ledger.

Example: TEST5678

Body

application/json

processIdstringOptional

This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this. If provided, it must have a v4 UUID format.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

securityIdstringOptional

This is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional. Either "securityId" or "securityCorrelationData" must be provided, but not both.

Example: USS3JKS01I00

Responses

200

Successfully triggered the cancellation of the capital event.The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

processIdstringRequired

This is used to uniquely identity a transaction process on this system.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

orchestrationIdstringRequired

The orchestration id. It is used to uniquely identity a group of transactions that are being orchestrated following an action request.If a processId was passed as an input to the action, it will be returned on this property.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

400

The following error codes can be returned: - GN0002 - TX0006 - CE0003 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 - CE0002 - IS0099 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - CE0001 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0119 - IS0013 - IS0012 - IS0015 - CE0005 - CE0035 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/capital-events/{capitalEventId}/cancel

HTTPcURLJavaScriptPython

PUT /external/v1/capital-events/{capitalEventId}/cancel HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "signer": {
    "email": "[email protected]",
    "name": "John Doe"
  },
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "securityId": "USS3JKS01I00",
  "securityCorrelationData": {
    "correlationId": "USS3JKS01I00",
    "orgId": "US9QIMA"
  }
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}

Important Notes

• securityId: uniquely identifies the fund/offering. See Managing the SecurityId.

• See Blockchain Transaction Tracking for information on using orchestrationId and processId.

\