AM/FA - Create Capital Event

The first step in the flow for a capital call or distribution is to create a capital event.

Details

/external/v1/capital-events

Synopsis

Create Capital Event

post

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".

Required scopes

This endpoint requires the following scopes:

• : manageCapitalEvent

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

transactionDataall ofRequired

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

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

eventDataall ofRequired

This property contains the details of the capital event that is to be created

Example: {"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}]}

bookedCapitalEventIdstring · max: 12Optional

This is the booked unique identifier of the capital event. It is optional. If not provided, a new unique identifier will be generated.

Example: USS3JKS01I00

Responses

201

Successfully triggered the creation of the capital eventThe "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 - IS0008 - IS0106 - CE0030 - CE0020 - CE0021 - CE0022 - CE0023 - CE0057 - CE0065 - CE0037 - CE0016 - CE0017 - CE0018 - CE0019 - CE0043 - CE0066 - CE0067 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 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 - CE0031 - CE0032 - CE0013 - CE0014 - CE0015 - CE0039 - CE0038 - CE0057 - CE0065 - CE0058 - CE0059 - CE0063 - CE0060 - CE0064 - TR0005 Please refer to the error code dictionary for the details of each error code.

application/json

425

The following error codes can be returned: - GN0003 Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/capital-events

HTTPcURLJavaScriptPython

POST /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"
  ]
}

Important Notes

• securityId: uniquely identifies the fund/offering. See Managing the SecurityId.

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