AM/FA - Apply Asset Capital Event

Details

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

Synopsis

Apply Asset Capital Event

put

This route is used to apply the capital event (capital call or distribution) on a batch of assets 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 if the capital event is in one of the following statuses: ["draft"] 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

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the capital event is being applied to assets

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

Responses

200

Successfully triggered the application of the capital event on the assetsThe "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 - TX0006 - CE0003 - CE0057 - CE0065 - CE0037 - CE0016 - CE0017 - CE0018 - CE0019 - 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 - CE0026 Please refer to the error code dictionary for the details of each error code.

application/json

put

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

HTTPcURLJavaScriptPython

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

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "assetDetails": [
    {
      "assetId": "USS3JKS01I00",
      "amountCalled": 1000,
      "expenses": 9000,
      "breakdown": [
        {
          "categoryId": "USS3JKS01I00",
          "amount": 9000,
          "extraData": {
            "some": "Global data"
          }
        }
      ],
      "extraData": {
        "some": "Custom Property"
      }
    }
  ]
}

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