AM/FA - Run Close

When the asset manager/fund administrator is ready to issue securities on the subscriptions received so far, they can run a close for the issuance.

Details

/external/v1/primary/run-close

Synopsis

Run Close

post

This route is used to trigger the process to run the close.

This should be called by the issuer or fund admin when the assets are ready to be issued. All the assets that have been accepted (and settled when there is up-front payment) will be issued.

For contingent offerings, only after the minimum amount is reached can this action be invoked.

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","paused"].

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

Authorizations

Body

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the close is being run

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

closeDataall ofRequired

This property contains the close data (e.g. issue price, date)

Example: {"priceData":[{"price":10.23,"asOfDate":"2024-09-12T00:00:00.000Z","bypassNAVCheck":true}],"issueDate":"2024-09-12T00:00:00.000Z"}

bookedCloseIdstring · max: 12Optional

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

Example: USS3JKS01I00

Responses

201

Successfully triggered the process to run the close. 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 - IS0082 - IS0083 - IS0084 - IS0085 - IS0086 - IS0092 - IS0093 - IC0010 - IC0012 - IC0009 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 - IS0088 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 - IS0002 - IS0010 - IS0025 - IS0081 - IS0087 - IS0089 - IS0091 - IS0094 - IS0090 - IS0114 - AS0030 Please refer to the error code dictionary for the details of each error code.

application/json

post

HTTPcURLJavaScriptPython

POST /external/v1/primary/run-close HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 283

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "closeData": {
    "priceData": [
      {
        "price": 10.23,
        "asOfDate": "2024-09-12T00:00:00.000Z",
        "bypassNAVCheck": true
      }
    ],
    "issueDate": "2024-09-12T00:00:00.000Z"
  },
  "bookedCloseId": "USS3JKS01I00"
}

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