AM - Set Tender Offer Price

Details

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

Synopsis

Set Tender Offer Price

put

This route is used to trigger the set of the tender offer price and total number of shares accepted. It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints. The tender offer will be moved to the 'price_set' state on the ledger once the actions triggered by this endpoint are complete. 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: ["closed","price_set"]. 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

Responses

200

Successfully triggered the process to set the tender offer price

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 - TO0026 - TO0027 - TO0022 - TO0023 - TO0025 - TO0058 - TO0059 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}/price

HTTPcURLJavaScriptPython

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

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "tenderOfferData": [
    {
      "securityId": "SOMESECURITY1",
      "priceClosed": 10.1234,
      "totalSharesNumberAccepted": 5000.987654
    },
    {
      "securityId": "SOMESECURITY2",
      "priceClosed": 20.1234,
      "totalSharesNumberAccepted": 2000.123
    }
  ]
}

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

Important Notes

• Tender offer must be closed.

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