AM - Create Tender Offer

Details

/external/v1/tender-offers

Synopsis

Create Tender Offer

post

This route is used to trigger the creation of a tender offer on the blockchain for a particular security.

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 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".

Authorizations

oauth2

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the tender offer is being created

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

tenderOfferDataall ofRequired

This property contains the tender offer data

Example: {"startDate":"2024-09-12T00:00:00.000Z","cutOffDate":"2024-09-12T00:00:00.000Z","closeDate":"2024-09-12T00:00:00.000Z","settlementDate":"2024-09-12T00:00:00.000Z"}

bookedTenderOfferIdstring · max: 12Optional

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

Example: USS3JKS01I00

Responses

201

Successfully triggered the creation of the tender offer

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

application/json

400

The following error codes can be returned:

• GN0002

• IS0008

• IS0106

• TO0016

• TO0044

• TO0017

• TO0045

• TO0060

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:

• IS0009

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

application/json

409

The following error codes can be returned:

• IS0013

• IS0012

• IS0010

• IS0002

• IS0117

• TO0014

• TO0015

• TO0018

• TO0019

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

application/json

post

HTTPcURLJavaScriptPython

POST /external/v1/tender-offers HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "tenderOfferData": {
    "startDate": "2024-09-12T00:00:00.000Z",
    "cutOffDate": "2024-09-12T00:00:00.000Z",
    "closeDate": "2024-09-12T00:00:00.000Z",
    "settlementDate": "2024-09-12T00:00:00.000Z"
  },
  "bookedTenderOfferId": "USS3JKS01I00"
}

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

Important Notes

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