AM/FA - External Close

Details

/external/v1/primary/external-close

Synopsis

External Close

put

This route is used to trigger the process the external 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.

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

oauth2

Body

application/json

transactionDataall ofRequired

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

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

Responses

200

Successfully triggered the process to record an external assets issuance. 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

• AS0038

• AS0039

• AS0040

• AS0018

• IS0083

• IS0082

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

• IS0096

• AS0007

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

• IS0094

• IS0117

• AS0030

• AS0005

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

application/json

put

HTTPcURLJavaScriptPython

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

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "externalIssuanceData": [
    {
      "assetId": "USS3JKS01I00",
      "priceData": {
        "price": 10.23,
        "sharesNumber": 100
      },
      "issuedDate": "2024-09-12T00:00:00.000Z"
    }
  ]
}

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