AM/FA - Apply Tender Offer Price

Details

/external/v1/tender-offers/{tenderOfferId}/price/apply

Synopsis

Apply Tender Offer Price

put

This route is used to trigger apply tender offer price to all tender requests. This can be invoked after the price is approved or on the ledger. 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: ["price_approved"]. 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

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenderOfferIdanyRequired

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

Example: TEST6688

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the tender offer action is to take place

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

Responses

200

Successfully triggered the process to apply the tender offer price to all tender requests

application/json

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 - TO0009 - AS0030 - TD0010

Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/tender-offers/{tenderOfferId}/price/apply

HTTPcURLJavaScriptPython

PUT /external/v1/tender-offers/{tenderOfferId}/price/apply HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "tradesApplyData": [
    {
      "tradeId": "US9QITROAS3A",
      "acceptedSharesNumber": 5000,
      "inputAssets": [
        {
          "assetId": "US9QIMAOAS1Q",
          "acceptedSharesNumber": 5000
        }
      ]
    }
  ]
}

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

Important Notes

• Offer price has been approved (for managed funds).

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

\