/external/v1/tender-offers/{tenderOfferId}/reject
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
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".
The unique identifier of the asset on the blockchain
US9QIMAOAS1QThis property contains the transactional data information, i.e. which is the security being bought and the investment details
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/primary/asset/{assetId}/decline HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"assetId": "US9QIMAOAS1Q",
"fileIds": [
"US9QIFILE1",
"US9QIFILE2"
],
"referenceData": {
"account": {
"accountId": "US9QIMAOAS1Q",
"custodian": {
"custodianId": "US9ZIMAOAS1Q"
}
},
"investors": [
{
"investorId": "US9QIM123S1Q"
}
]
},
"completedByAdvisor": {
"advisorId": "OG12JUS03I04"
},
"dryRun": true
}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".
The id that uniquely identifies the tender offer on the ledger.
TEST6688This 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.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis 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.
USS3JKS01I00This 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".
PUT /external/v1/tender-offers/{tenderOfferId}/reject 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"
}