TA - Reject Tender Offer

Details

/external/v1/tender-offers/{tenderOfferId}/reject

Synopsis

Reject Tender Offer

put

This route is used to trigger rejection of the tender offer. This is to be used when an asset manager that owns this security has a fund admin assigned to this security and one of them has already approved the tender offer on the ledger. This will move the tender offer back to draft and its details can be updated. 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: ["pending"]. 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't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "manageTenderOffer".

Required scopes

This endpoint requires the following scopes:

: manageTenderOffer

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenderOfferIdanyRequired

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

Example: TEST6688

Body

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 rejection of the tender offer

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 - IS0008 - IS0106 - TO0002 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 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 - IS0010 - IS0002 - IS0018 - IS0117 - TO0003 - TO0005 - TO0004 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/tender-offers/{tenderOfferId}/reject

PUT /external/v1/tender-offers/{tenderOfferId}/reject 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"
}

Decline Digital Asset

put

This route is used to trigger the decline (cancel + dispose) of a digital asset on the blockchain for a particular security.

This should be called after the asset has already been accepted by the issuer but the payment was not received.

This triggers an asynchronous process (the id of which is returned on the success response) to persist this information on the blockchain which can be monitored using the "Transactions API" endpoints.

Once processed, the asset will be disposed.

This endpoint can be invoked if the security is in one of the following statuses: ["active","paused"].

This endpoint can be invoked if the asset is in one of the following statuses: ["confirmed","settlement_confirmation_pending"].

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't be invoked if the security is restricted.

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

Required scopes

This endpoint requires the following scopes:

: disposeSubscription

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

assetIdanyRequired

The unique identifier of the asset on the blockchain

Example: US9QIMAOAS1Q

Body

Responses

200

Successfully triggered the process to decline the asset on the ledger.

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

The "assetId" property can be used on the "Assets API" to get the details of the digital asset.

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

assetIdstringRequired

The ID of the digital asset that uniquely identifies it on the ledger

Example: US9QIMAOAS1Q

fileIdsstring[]Required

The created document(s) file ID(s). Each ID uniquely identifies a file on the ledger.

Example: ["US9QIFILE1","US9QIFILE2"]

dryRunbooleanOptional

This property reflects if the request was executed in dry run mode.

Example: true

400