Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
If an investor does not meet their commitment for a capital call, their shares are marked as failed. Here, an asset represents multiple shares, or a lot, of a given security.
/external/v1/capital-events/{capitalEventId}/assets/fail
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
\
A capital event must be approved before it can proceed.
/external/v1/capital-events/{capitalEventId}/approve
securityId: uniquely identifies the fund/offering. See Managing the SecurityId.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
\
You can cancel a capital event before launch.
/external/v1/capital-events/{capitalEventId}/cancel
securityId: uniquely identifies the fund/offering. See Managing the SecurityId.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
\
A fund administrator or asset manager can request a change for a capital event before approving.
/external/v1/capital-events/{capitalEventId}/reject
securityId: uniquely identifies the fund/offering. See Managing the SecurityId.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
\
Before a capital event has been approved, the asset manager and fund administrator can make updates.
/external/v1/capital-events/{capitalEventId}
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
Once an investor funds a capital call, that fact needs to be recorded in the Corastone portal. Here, an asset represents multiple shares, or a lot, of the corresponding security.
/external/v1/capital-events/{capitalEventId}/assets/fund
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
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.
/external/v1/capital-events/{capitalEventId}/assets/recover
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
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.
TEST5678This 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"
}This route is used to trigger the failure of the capital event (specific to capital calls) on a batch of assets 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 not been received and the information that the investors have failed their obligations needs to be reflected on the ledger.
If this is triggered then the asset will enter 'default' state and will be restricted for 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".
The id that uniquely identifies the capital event on the ledger.
TEST5678This property contains the transactional data information, i.e. which is the security where the capital event is happening
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/capital-events/{capitalEventId}/assets/fail HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"assetsData": [
{
"assetId": "US9QIMAOAS1Q",
"extraData": {
"whatever": "Extra Data that is needed"
}
}
]
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger approval of the capital event (capital call or distribution).
If the asset manager that owns this security does not have any fund admins assigned to this offering, then once this call is completed the capital event will be marked as active on the ledger.
If the asset manager that owns this security has a fund admin then both organizations need to call this endpoint one after the other to mark this capital event as active on the ledger.
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","pending"]
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 "manageCapitalEvent".
The id that uniquely identifies the capital event on the ledger.
TEST5678This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this.
If provided, it must have a v4 UUID format.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/capital-events/{capitalEventId}/approve HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the cancellation of the capital event (capital call or distribution).
This is an irreversible action that can be called if the event is in draft state. The typical use case for this endpoint is to cancel an event that was created by mistake.
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.
TEST5678This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this.
If provided, it must have a v4 UUID format.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/capital-events/{capitalEventId}/cancel HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the settlement of the capital event (capital call or distribution) on a batch of assets on the blockchain for a particular security.
e.g., after the amount of the call has been received and the information that the investors have met their obligations needs to be reflected on the ledger.
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"]
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.
TEST5678This property contains the transactional data information, i.e. which is the security where the capital event is happening
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/capital-events/{capitalEventId}/assets/settle HTTP/1.1
Host:
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"
}This route is used to trigger process to request changes of the capital event (capital call or distribution).
This is to be used when an asset manager that owns this security has a fund admin assigned to this security and one of them has already approved the capital event on the ledger.
This will move the capital event back to draft and its details can be updated.
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: ["pending"]
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 "manageCapitalEvent".
The id that uniquely identifies the capital event on the ledger.
TEST5678This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this.
If provided, it must have a v4 UUID format.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/capital-events/{capitalEventId}/reject HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to remove a correlation ID from an existing capital event. This correlation ID is an externally provided id that uniquely identifies the capital event within the organization making this call.
This correlation ID should be in use by the capital event involved in this call.
This action can be broadcast to all the counterparties that have access to this capital event.
If the action is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
The unique identifier of the capital event on the blockchain
US9QIMAOAS1QExternally provided id that uniquely identifies an entity within an organization.
123245573717This property contains the transactional data information, i.e. which is the security where we are adding a correlation id to a entity
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/capital-events/{capitalEventId}/correlation-id/remove HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"correlationId": "123245573717",
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}This route is used to trigger the update of a capital event (capital call or distribution) 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 will trigger either 1 or 2 transactions depending on the input (if assetDetails property is passed then it will be 2 transactions)
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","pending"]
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 "manageCapitalEvent".
The id that uniquely identifies the capital event on the ledger.
TEST5678This property contains the transactional data information, i.e. which is the security where the capital event is being created
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}This property contains the details of the capital event that is to be updated
{"endDate":"2024-09-12T00:00:00.000Z","amountCalled":100000,"expenses":2000,"breakdown":[{"category":{"bookedCategoryId":"USS3JKS01I00","data":{"type":"investments","flowType":"againstCommitment","extraData":{"some":"Custom Data"}}},"amount":90000,"extraData":{"some":"Global data"}},{"category":{"data":{"type":"managementFeeInsideCommitment","flowType":"againstCommitment"}},"amount":10000},{"category":{"data":{"type":"managementFeeOutsideCommitment","flowType":"expenses","extraData":{"other":"Specific Data field"}}},"amount":2000},{"category":{"categoryId":"USS3JKS01I00"},"amount":4000}]}PUT /external/v1/capital-events/{capitalEventId} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 717
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"eventData": {
"endDate": "2024-09-12T00:00:00.000Z",
"amountCalled": 100000,
"expenses": 2000,
"breakdown": [
{
"category": {
"bookedCategoryId": "USS3JKS01I00",
"data": {
"type": "investments",
"flowType": "againstCommitment",
"extraData": {
"some": "Custom Data"
}
}
},
"amount": 90000,
"extraData": {
"some": "Global data"
}
},
{
"category": {
"data": {
"type": "managementFeeInsideCommitment",
"flowType": "againstCommitment"
}
},
"amount": 10000
},
{
"category": {
"data": {
"type": "managementFeeOutsideCommitment",
"flowType": "expenses",
"extraData": {
"other": "Specific Data field"
}
}
},
"amount": 2000
},
{
"category": {
"categoryId": "USS3JKS01I00"
},
"amount": 4000
}
]
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to add a correlation ID to an existing capital event. This correlation ID is an externally provided id that uniquely identifies the capital event within the organization making this call.
This correlation ID can't be in use by another capital event. This correlation ID can be broadcast to all the counterparties that have access to this capital event.
If the ID is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
The unique identifier of the capital event on the blockchain
US9QIMAOAS1QExternally provided id that uniquely identifies an entity within an organization.
123245573717This property defines if correlation information will be sent to all counterparties.
falseExample: trueThe organization origin system that created this entity correlation id
Backoffice-system-123This property contains the transactional data information, i.e. which is the security where we are adding a correlation id to a entity
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/capital-events/{capitalEventId}/correlation-id/add HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"correlationId": "123245573717",
"broadcastToCounterparty": true,
"origin": "Backoffice-system-123",
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}This route is used to trigger the closure of the capital event (capital call or distribution).
This can either be called if the event has either been settled or failed on all assets.
This is the final step in the capital event lifecycle.
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"]
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.
TEST5678This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this.
If provided, it must have a v4 UUID format.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/capital-events/{capitalEventId}/close HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the creation of a capital event (capital call or distribution) 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 will trigger either 1 or 2 transactions depending on the input (if assetDetails property is passed then it will be 2 transactions)
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 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 "manageCapitalEvent".
This property contains the transactional data information, i.e. which is the security where the capital event is being created
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}This property contains the details of the capital event that is to be created
{"type":"capitalCall","endDate":"2024-09-12T00:00:00.000Z","amountCalled":100000,"expenses":2000,"breakdown":[{"category":{"bookedCategoryId":"USS3JKS01I00","data":{"type":"investments","flowType":"againstCommitment","extraData":{"some":"Custom Data"}}},"amount":90000,"extraData":{"some":"Global data"}},{"category":{"data":{"type":"managementFeeInsideCommitment","flowType":"againstCommitment"}},"amount":10000},{"category":{"data":{"type":"managementFeeOutsideCommitment","flowType":"expenses","extraData":{"other":"Specific Data field"}}},"amount":2000},{"category":{"categoryId":"USS3JKS01I00"},"amount":4000}]}This is the booked unique identifier of the capital event. It is optional. If not provided, a new unique identifier will be generated.
USS3JKS01I00POST /external/v1/capital-events HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 776
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"eventData": {
"type": "capitalCall",
"endDate": "2024-09-12T00:00:00.000Z",
"amountCalled": 100000,
"expenses": 2000,
"breakdown": [
{
"category": {
"bookedCategoryId": "USS3JKS01I00",
"data": {
"type": "investments",
"flowType": "againstCommitment",
"extraData": {
"some": "Custom Data"
}
}
},
"amount": 90000,
"extraData": {
"some": "Global data"
}
},
{
"category": {
"data": {
"type": "managementFeeInsideCommitment",
"flowType": "againstCommitment"
}
},
"amount": 10000
},
{
"category": {
"data": {
"type": "managementFeeOutsideCommitment",
"flowType": "expenses",
"extraData": {
"other": "Specific Data field"
}
}
},
"amount": 2000
},
{
"category": {
"categoryId": "USS3JKS01I00"
},
"amount": 4000
}
]
},
"bookedCapitalEventId": "USS3JKS01I00"
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"capitalEventId": "US9QIMAOAS1Q",
"breakdownCategoriesIds": [
"USS3JKS01I00"
]
}This route is used to trigger the funding of the capital event by investors (specific to capital calls) on a batch of assets.
This should be called to let the issuer know when the investors meet their capital obligations
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: ["investor"].
This endpoint can be called by applications with access to scope "manageCapitalEvent".
The id that uniquely identifies the capital event on the ledger.
TEST5678This property contains the transactional data information, i.e. which is the security where the capital event is happening
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/capital-events/{capitalEventId}/assets/fund HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"assetsData": [
{
"assetId": "US9QIMAOAS1Q",
"settlementData": {
"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"
}This route is used to get the details regarding a capital event (Capital Call / Distribution), given a set of search filters.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of security ids to filter the capital events records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the capital events records. Up to 10 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of capital event correlation ids to filter the capital event records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of capital event ids to filter the capital event records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of statuses to filter the capital event records. Up to 9 entries can be provided. Available values: preSync, deleted, draft, pending, approval_in_progress, active, closed, canceled, cancel_in_progress
draft,activeGET /external/v1/capital-events HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"type": "capitalCall",
"endDate": "2024-09-12T00:00:00.000Z",
"amountCalled": 100000,
"expenses": 2000,
"temporaryDistributionAmount": 100000,
"permanentDistributionAmount": 2000,
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies capital event on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
],
"status": "draft",
"capitalEventId": "US9QIMAOAS1Q",
"securityId": "USS3JKS01I00",
"breakdown": [
{
"categoryId": "USS3JKS01I00",
"amount": 90000,
"extraData": {
"some": "Custom Data"
}
},
{
"categoryId": "USS3JKS01I01",
"amount": 10000
}
],
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
}
]This route is used to retrieve the history data entries of breakdown categories given a set of filters such as blockchain details or categories identifiers.
The history entries will reflect the state of the breakdown categories on a particular block on the ledger.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of breakdown category ids to filter the category records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01GET /external/v1/capital-events/categories/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"event": "Published",
"update": {
"securityId": "USS3AAS34CKH",
"categoryId": "USS3JKS01I00",
"status": "published",
"type": "investments",
"flowType": "againstCommitment",
"description": "Call from LPs, on behalf of GP share of a capital call",
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
}
}
]This route is used to retrieve the details of breakdown categories, given a set of search filters.
This endpoint is paginated, up to 100 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of security ids to filter the breakdown category records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the breakdown category records. Up to 10 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of breakdown category ids to filter the category records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01GET /external/v1/capital-events/categories HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"type": "deemedGPContribution",
"typeName": "Other Expenses",
"flowType": "againstCommitment",
"description": "Call from LPs, on behalf of GP's share of a capital call (typically serves as an offset to future management fees)",
"securityId": "USS3JKS01I00",
"categoryId": "USS3JKS01I00",
"status": "published",
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
}
]This route is used to retrieve the history of a correlation IDs of a particular capital event, given a set of search filters.
This endpoint returns paginated data. Up to 20 can be extracted per call.
This endpoint can be called by applications with access to scope "manageReferenceData".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of capital event correlation ids to filter the capital event records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of capital event ids to filter the capital event records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01GET /external/v1/capital-events/correlation-id/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"event": "Created",
"update": {
"correlationId": "123245573717",
"entityType": "account",
"entityId": "OG1234567890",
"status": "broadcast",
"origin": "Backoffice-system-123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
}
}
}
]This route is used to get the details regarding a capital event (Capital Call / Distribution) at the asset level, given a set of search filters.
i.e., the details of how much is being called/distributed from/to each asset.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of capital event correlation ids to filter the asset capital event records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of capital event ids to filter the asset capital event records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of asset ids to filter the asset capital events records. Up to 500 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of asset correlation ids to filter the asset capital events records. Up to 50 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "assetCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of statuses to filter the asset capital event records. Up to 8 entries can be provided. Available values: preSync, draft, active, settled, failed, funded, fundedAfterFailure, canceled
draft,activeGET /external/v1/capital-events/assets HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"assetId": "USS3JKS01I00",
"amountCalled": 100000,
"expenses": 2000,
"temporaryDistributionAmount": 100000,
"permanentDistributionAmount": 2000,
"breakdown": [
{
"categoryId": "USS3JKS01I00",
"amount": 90000,
"extraData": {
"some": "Custom Data"
}
},
{
"categoryId": "USS3JKS01I01",
"amount": 10000
}
],
"settlementData": [
{
"date": "2024-09-12T00:00:00.000Z",
"status": "settled",
"amount": 1000
}
],
"status": "active"
}
]This route is used to get the history of a capital event (Capital Call / Distribution), given a set of search filters.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of capital event correlation ids to filter the capital event history records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of capital event ids to filter the capital event history records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01GET /external/v1/capital-events/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"event": "Created",
"update": {
"type": "capitalCall",
"endDate": "2024-09-12T00:00:00.000Z",
"amountCalled": 100000,
"expenses": 2000,
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"breakdown": [
{
"categoryId": "USS3JKS01I00",
"amount": 9000
},
{
"categoryId": "USS3JKS01I01",
"amount": 10000
},
{
"categoryId": "USS3JKS01I02",
"amount": 2000,
"extraData": {
"other": "Fund Level Information"
}
}
],
"status": "draft",
"capitalEventId": "US9QIMAOAS1Q",
"securityId": "USS3JKS01I00"
}
}
]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".
The id that uniquely identifies the capital event on the ledger.
TEST5678This property contains the transactional data information, i.e. which is the security where the capital event is happening
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/capital-events/{capitalEventId}/assets/recover HTTP/1.1
Host:
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"
}This route is used to retrieve the history data entries of all assets capital events on the ledger, given a set of search filters.
The history entries will reflect the state of the assets capital events on that particular block.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of capital event correlation ids to filter the asset capital event history records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of capital event ids to filter the asset capital event history records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of asset ids to filter the asset capital event history records. Up to 500 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of asset correlation ids to filter the asset capital event history records. Up to 50 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "assetCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/capital-events/assets/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"event": "CapitalCallApplied",
"update": {
"assetId": "USS3JKS01",
"capitalEventId": "US9QIMAOAS1Q",
"amountCalled": 100000,
"expenses": 2000,
"breakdown": [
{
"categoryId": "USS3JKS01I00",
"amount": 90000,
"extraData": {
"some": "Custom Data"
}
},
{
"categoryId": "USS3JKS01I01",
"amount": 10000
}
],
"status": "draft",
"extraData": {
"some": "Extra Data"
}
}
}
]