All pages
Powered by GitBook
1 of 1

Loading...

Inv - Cancel Tender Offer Request

Details

/external/v1/tender-offers/{tenderOfferId}/request/{tradeId}/cancel

Synopsis

Important Notes

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

Cancel Tender Request

put

This route is used to cancel a tender request. This action can only be performed by the investor organization that submitted it in the first place.

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 tender offer is in one of the following statuses: ["active","closed"].

This endpoint can be invoked if the tender request is in one of the following statuses: ["proposed"].

This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["investor"].

This endpoint can't be invoked if the security is restricted.

This endpoint can be called by applications with access to scope "manageTenderRequest".

Authorizations
Path parameters
tradeIdanyRequired

The id that uniquely identifies the tender request on the ledger. It is the output of the create tender request endpoint.

Example: TRADE123
tenderOfferIdanyRequired

The id that uniquely identifies the tender offer on the ledger.

Example: TEST6688
Body
signerall ofRequired

This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.

This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.

Example: {"email":"[email protected]","name":"John Doe"}
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
securityCorrelationDataall ofOptional

This property contains the correlation data that is used to identify a particular security within an organization. It is optional.

Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".

Responses
200
Successfully triggered the process to cancel the tender request.
application/json
400
The following error codes can be returned: - GN0002 - IS0008 - IS0106 - TO0002 - TD0002 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 - 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: - TO0001 - TD0001 - IS0009 Please refer to the error code dictionary for the details of each error code.
application/json
409
The following error codes can be returned: - IS0013 - IS0012 - IS0018 - TO0003 - TO0005 - TO0004 - TO0006 - TO0007 - TO0008 - TO0040 - TO0061 - TD0003 - AS0030 - TD0010 Please refer to the error code dictionary for the details of each error code.
application/json
put
PUT /external/v1/tender-offers/{tenderOfferId}/requests/{tradeId}/cancel HTTP/1.1
Host: 
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"
}