Equities

get

Retrieve a list of equities available in the system

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Default: ORPossible values:

orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, nominalValue, issueDate, status, name, supply, undistributedAmount

Responses

200

Successfully retrieved a list of items.

application/json

Responseall of

get

/equities

GET /equities HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "id": "5ac4776b-85d1-4e5a-9acb-e85aa18b5618",
      "currencyId": "1f0939a5-24e0-4529-b148-46fe138aa422",
      "issuerId": "82eb08fc-ce34-4b5e-98ba-eec64e64d553",
      "nominalValue": 10000,
      "issueDate": "2024-05-09T10:00:00.000Z",
      "status": "recorded",
      "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
      "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
      "name": "UAB Trys Gaideliai nematerialios akcijos",
      "supply": 5000000,
      "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
      "isin": "US4592001014",
      "undistributedAmount": 2000
    }
  ]
}

post

Create a new equity. Prepares blockchain accounts and issues provided total supply from cold to warm wallet. Makes equity ready for distribution.

Body

namestringRequired

A user friendly name of the asset (ex. Orange Bond)

Example: UAB Trys Gaideliai nematerialios akcijos

totalSupplyinteger · int64Required

Total supply of the asset that exist amongst all existing platforms together

Example: 5000000

currencyIdstring · uuidRequired

Unique UUID of the currency in scope of this gateway provided

Example: b6c1d2be-c60f-4ddd-9ce1-a49d100f6ff4

issuerIdstring · uuidRequired

Unique UUID of issuer in scope of this gateway

Example: 5d958300-5291-4799-8d60-af63850334e8

nominalValueinteger · int64Required

Price of ONE share in sub-units

Example: 10000

issueDatestring · date-timeRequired

Issue registration date

Example: 2024-05-09T10:00:00.000Z

isinstring | nullableOptional

An International Securities Identification Number

Example: US4592001014

Responses

201

Successfully created an equity.

application/json

post

/equities

POST /equities HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "totalSupply": 5000000,
  "currencyId": "b6c1d2be-c60f-4ddd-9ce1-a49d100f6ff4",
  "issuerId": "5d958300-5291-4799-8d60-af63850334e8",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "isin": "US4592001014"
}

201

Successfully created an equity.

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "5ac4776b-85d1-4e5a-9acb-e85aa18b5618",
  "currencyId": "1f0939a5-24e0-4529-b148-46fe138aa422",
  "issuerId": "82eb08fc-ce34-4b5e-98ba-eec64e64d553",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "status": "recorded",
  "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
  "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "supply": 5000000,
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "isin": "US4592001014",
  "undistributedAmount": 2000
}

get

Retrieve full information about a single equity, specified by equity id in the path.

Path parameters

equityIdstring · uuidRequired

Unique UUID of the equity in scope of this gateway.

Example: 6ef453ec-d8fc-4799-939d-5518df7298cd

Responses

200

Successfully received equity.

application/json

get

/equities/{equityId}

GET /equities/{equityId} HTTP/1.1
Host: 
Accept: */*

200

Successfully received equity.

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "5ac4776b-85d1-4e5a-9acb-e85aa18b5618",
  "currencyId": "1f0939a5-24e0-4529-b148-46fe138aa422",
  "issuerId": "82eb08fc-ce34-4b5e-98ba-eec64e64d553",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "status": "recorded",
  "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
  "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "supply": 5000000,
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "isin": "US4592001014",
  "undistributedAmount": 2000
}

patch

Issue additional equity tokens or burn existing ones, changing the total supply and, if chosen, nominal value.

Path parameters

equityIdstring · uuidRequired

Unique UUID of the equity in scope of this gateway.

Example: 810cb12e-8283-4787-8bad-8d64091017fe

Body

supplyinteger · int64Optional

Change supply of the equity to new amount (implies issuing additional equities or burning existing ones)

Example: 100

nominalValueinteger · int64Optional

New nominal value of the equity. If not provided, will remain the same.

Example: 10000

statusstring · enumOptional

New equity status

Possible values:

referencestringRequired

Reference to a document or corporate action number, etc. - anything that could help relate supply or nominal value change with other context

Example: Stock-split No. 12345

recordedAtstring · date-timeRequired

Day when the action was documented to be executed. This is not necessarily the day when the equity is actually changing supply or nominal value

Example: 2024-05-09T10:00:00.000Z

Responses

200

Equity successfully updated.

application/json

patch

/equities/{equityId}

PATCH /equities/{equityId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "supply": 100,
  "nominalValue": 10000,
  "status": "closed",
  "reference": "Stock-split No. 12345",
  "recordedAt": "2024-05-09T10:00:00.000Z"
}

200

Equity successfully updated.

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "5ac4776b-85d1-4e5a-9acb-e85aa18b5618",
  "currencyId": "1f0939a5-24e0-4529-b148-46fe138aa422",
  "issuerId": "82eb08fc-ce34-4b5e-98ba-eec64e64d553",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "status": "recorded",
  "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
  "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "supply": 5000000,
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "isin": "US4592001014",
  "undistributedAmount": 2000
}

post

Deduct equities from investors.

Path parameters

equityIdstring · uuidRequired

Unique UUID of the equity in scope of this gateway.

Example: 72d9f131-1afa-4f7b-9340-c5384045ee90

Body

referencestringRequired

Reference to a document or corporate action number, etc. - anything that could help relate deduction actions with other context

Example: Stock-split No. 12345

recordedAtstring · date-timeRequired

Day when the action was documented to be executed. This is not necessarily the day when the equity is actually deducted from the investor.

Example: 2024-05-09T10:00:00.000Z

Responses

201

Successfully created equity deduction

application/json

post

/equities/{equityId}/deductions

POST /equities/{equityId}/deductions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "reference": "Stock-split No. 12345",
  "recordedAt": "2024-05-09T10:00:00.000Z",
  "deductees": [
    {
      "address": "text",
      "amount": 1000
    }
  ]
}

201

Successfully created equity deduction

[
  {
    "id": "694c4022-b304-46c8-b3cd-68dadce7bc79",
    "equityId": "1fd8d771-c155-4a13-ac8d-12a09a1f027f",
    "accountAddress": "text",
    "amount": 10,
    "reference": "Stock-split No. 12345",
    "recordedAt": "2024-05-09T10:00:00.000Z",
    "status": "successful"
  }
]

post

Create equity distribution.

Path parameters

equityIdstring · uuidRequired

Unique UUID of the equity in scope of this gateway.

Example: 2546e74a-a019-4b07-b8a1-48a16d575f8b

Body

referencestringRequired

Reference to a document or corporate action number, etc. - anything that could help relate distribution actions with other context

Example: Stock-split No. 12345

recordedAtstring · date-timeRequired

Day when the action was documented to be executed. This is not necessarily the day when the equity is actually distributed to the investor.

Example: 2024-05-09T10:00:00.000Z

Responses

201

Successfully created equity distribution

application/json

post

/equities/{equityId}/distributions

POST /equities/{equityId}/distributions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "reference": "Stock-split No. 12345",
  "recordedAt": "2024-05-09T10:00:00.000Z",
  "distributees": [
    {
      "address": "text",
      "amount": 10
    }
  ]
}

201

Successfully created equity distribution

[
  {
    "id": "e693be89-2a3e-4146-ab37-773588a32c9b",
    "equityId": "98d0eb86-04a6-4739-b5ad-1c431ee43cb7",
    "accountAddress": "r49wKDuk5e7oZNHiY5GtwBeAo7ioGoxoH",
    "amount": 10,
    "reference": "Stock-split No. 12345",
    "recordedAt": "2024-05-09T10:00:00.000Z",
    "status": "successful"
  }
]

get

Retrieve a list of accounts with balance for specified equity.

Path parameters

equityIdstring · uuidRequired

Unique UUID of the equity in scope of this gateway.

Example: 5bfc916a-6140-48aa-aadc-ddbb0817fdfd

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

Responseall of

get

/equities/{equityId}/accounts

GET /equities/{equityId}/accounts HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "account": {
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "nodeId": "08bc68e0-cf6d-457b-99ae-f1af131dec33",
        "address": "text",
        "type": "investor",
        "institutionSectorCode": "S.11",
        "walletType": "client-individual",
        "status": "active",
        "openedAt": "2025-10-12T13:47:34.726Z"
      },
      "amount": 10
    }
  ]
}

PreviousEmis NextIssuers