Inv - Submit Tender Request

Details

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

Synopsis

Submit Tender Request

post

This route is used to create a tender request by an investor organization with access to sell the assets in issued state. 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"]. 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".

Required scopes

This endpoint requires the following scopes:

• : manageTenderRequest

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenderOfferIdanyRequired

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

Example: TEST6688

Body

application/json

bookedTradeIdstring · max: 12Optional

This is the booked unique identifier of the tender request. It is optional. If not provided, a new unique identifier will be generated.

Example: USS3JKS01I00

Responses

201

Successfully triggered the creation of a tender request

application/json

400

The following error codes can be returned: - GN0002 - IS0008 - IS0106 - TO0002 - TD0009 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 - TO0006 - TO0007 - TO0030 - TO0031 - TO0032 - TO0033 - TO0028 - TO0029 - AS0030 Please refer to the error code dictionary for the details of each error code.

application/json

post

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

HTTPcURLJavaScriptPython

POST /external/v1/tender-offers/{tenderOfferId}/requests HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 419

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "input": [
    {
      "assetId": "TEST1234",
      "sharesNumber": 50.1234
    },
    {
      "assetId": "TEST5678",
      "sharesNumber": 200.987566
    }
  ],
  "correlationData": [
    {
      "broadcastToCounterparty": true,
      "correlationId": "123245573717",
      "origin": "Identifies tender request on backoffice",
      "extraData": {
        "some": "Custom Property"
      }
    }
  ],
  "bookedTradeId": "USS3JKS01I00"
}

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

Important Notes

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