AM/TA - Recover Asset Capital Event

After failure, the asset can be recovered if the amount is eventually received. Here, an asset represents multiple shares, or a lot, of a given security.

Details

/external/v1/capital-events/{capitalEventId}/assets/recover

Synopsis

Recover Asset Capital Event

put

This route is used to trigger the recovery of the capital event (specific to capital calls) on a batch of assets that had previously been marked as failed on the blockchain for a particular security. This can be used by either the asset manager that owns the security or by a fund admin that is assigned to the security, e.g. if the amount of the call has been received after the investors have failed their obligations and that information needs to be reflected. If this is triggered then the asset will exit 'default' state and can be used on further actions. 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 capital event is in one of the following statuses: ["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 be called by applications with access to scope "manageCapitalEvent".

Required scopes

This endpoint requires the following scopes:

• : manageCapitalEvent

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

capitalEventIdanyRequired

The id that uniquely identifies the capital event on the ledger.

Example: TEST5678

Body

application/json

Responses

200

Successfully triggered the recover of the capital event on the assets.The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

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 - TX0006 - CE0006 - CE0003 - AS0018 - AS0013 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 - CE0002 - 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: - CE0001 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 - IS0015 - CE0005 - CE0027 - CE0028 - CE0044 - CE0056 - AS0030 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/capital-events/{capitalEventId}/assets/recover

HTTPcURLJavaScriptPython

PUT /external/v1/capital-events/{capitalEventId}/assets/recover HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "assetsData": [
    {
      "assetId": "US9QIMAOAS1Q",
      "settlementData": {
        "status": "settled",
        "amount": 1000,
        "date": "2024-09-12T00:00:00.000Z"
      },
      "extraData": {
        "whatever": "Extra Data that is needed"
      }
    }
  ]
}

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

Important Notes

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