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".
The id that uniquely identifies the capital event on the ledger.
TEST5678
This property contains the transactional data information, i.e. which is the security where the capital event is being applied to assets
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}
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"
}