Bonds

get

Retrieve a list of bonds 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, seniority, status, nominalValue, totalNominalValue, interestRate, secured, issuedAt, issuanceRecordAt, settleAt, maturityRecordAt, matureAt, distributedAmount, acceptedAmount, requestedAmount, collectedAmount, supply, totalSupply

Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds
GET /bonds 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": "1e5c1b3f-bbcd-4b65-98a4-e8a374d3a337",
      "issuerId": "3b7db38c-9517-4e89-ba36-01e66297e93d",
      "currencyId": "31def7a6-3a8e-4b0c-8232-3781d82c7fce",
      "brokerId": "d951c9f8-3866-448c-9f32-d6900cfd7e2d",
      "origin": "native",
      "custodian": "Custodian Bank",
      "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
      "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
      "csdRegisteredAt": "2034-12-30T00:00:00.000Z",
      "underlyingInstrumentCode": "US0378331005",
      "fisn": "FUTURETECH/COMMON STOCK",
      "countryCode": "LT",
      "turnoverType": "public",
      "seniority": "senior-debt",
      "status": "closed",
      "initialPlacement": "public",
      "issuingAccountAddress": "text",
      "operationalAccountAddress": "text",
      "isin": "US0378331005",
      "cfi": "DBVUGR",
      "figi": "BBG000BLNNV0",
      "ticker": "AAPL",
      "dti": "BCDFGHJK9",
      "issuePrice": "20 000 USD",
      "nominalValue": 10,
      "totalNominalValue": 10000,
      "interestRate": "10",
      "interestType": "fixed",
      "interestBase": "act365",
      "interestInterval": "annual",
      "settlementUnitMultiple": 2,
      "minimumSettlementUnit": 2,
      "prospectusRegistered": true,
      "preEmptiveRights": true,
      "earlyRedemption": true,
      "secured": true,
      "securedBacking": "Gold",
      "issuedAt": "2034-12-30T00:00:00.000Z",
      "issuanceRecordAt": "2034-12-30T00:00:00.000Z",
      "settleAt": "2034-12-30T00:00:00.000Z",
      "maturityRecordAt": "2034-12-30T00:00:00.000Z",
      "matureAt": "2034-12-30T00:00:00.000Z",
      "distributedAmount": 1000,
      "acceptedAmount": 1000,
      "requestedAmount": 1000,
      "collectedAmount": 1000,
      "name": "BOND",
      "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
      "exponent": 2,
      "supply": 1000,
      "totalSupply": 1000,
      "couponIds": [
        "36dbd1cc-cc4a-43d0-a166-e3e4cd1380f7"
      ],
      "maturityPaymentIds": [
        "888431dc-1d81-4f6b-9131-475f8d3ee0f8"
      ],
      "distributionIds": [
        "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
      ],
      "supplyChangeIds": [
        "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
      ],
      "dataValidationIds": [
        "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
      ],
      "settlementType": "external"
    }
  ]
}
post

Create a new bond. Prepares blockchain accounts and makes data validation request to operator.

Body
issuerIdstring · uuidRequired

Unique UUID of the issuer in scope of this gateway to assign as this bond's issuer

Example: b3ce07c9-a17d-4d0b-9fd7-f734455688c3
currencyIdstring · uuidRequired

Unique UUID of the currency in scope of this gateway provided to set in which currency bond coupon and maturity payments will be executed with

Example: f888c2f1-f4dd-45ba-880e-ee5085821c89
namestringRequired

Full name of the bond

Example: Test Bond 1
originstring · enumRequired

Origin of the bond. Indicates the source of the bond

Default: nativeExample: nativePossible values:
custodianstringOptional

Custodian where asset is registered outside

Example: Custodian Bank
custodianLeiCodestringOptional

LEI code of original depository where the issuer has registered the securities

Example: DG3RU1DBUFHT4ZF9WN62
issuerCsdLeiCodestringOptional

LEI code of the issuer in central securities depository

Example: DG3RU1DBUFHT4ZF9WN62
csdRegisteredAtstring · date-timeOptional

Date of registration in central depository

Example: 2025-10-13T13:47:37.208Z
underlyingInstrumentCodestringOptional

Underlying instrument code

Example: US0378331005
fisnstringOptional

Short description

Example: FUTURETECH/COMMON STOCK
countryCodestringRequired

Country code of where the security is issued

Example: LT
turnoverTypestring · enumOptional

Type of turnover for the bond. Indicates how the bond is traded or transferred

Example: publicPossible values:
senioritystring · enumRequired

Seniority of the bond. Indicates the priority of claims in case of liquidation

Example: senior-debtPossible values:
initialPlacementstring · enumRequired

Initial placement type

Example: publicPossible values:
exponentnumberRequired

Bond exponent - number of fractional decimals allowed for the bond

Example: 2
isinstringOptional

International Securities Identification Number. Code that uniquely identifies a security globally

Example: US0378331005
cfistringOptional

Classification of Financial Instruments. Unique identifier assigned to financial instruments, such as stocks, bonds, derivatives, and other securities

Example: DBVUGR
figistringOptional

Financial Instrument Global Identifier. Code that uniquely identifies a security globally

Example: BBG000BLNNV0
tickerstringOptional

Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes

Example: AAPL
dtistring · iso-24165-dtiOptional

Digital Token Identifier (DTI) as per ISO 24165

Example: BCDFGHJK9Pattern: ^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$
issuePricestringRequired

Price of the bond issue

Example: 20 000 USD
totalSupplyinteger · int64Required

Total amount of bond units that exist or will exist, provided considering exponent of the bond

Example: 10000
nominalValueinteger · int64Required

Nominal/face value of one bond, expressed in chosen currency, provided considering exponent of the currency

Example: 100
interestRatestringRequired

Annual interest rate in % paid for holding this bond

Example: 10
interestTypestring · enumRequired

Interest type. Curently, only fixed interest rate is supported

Example: fixedPossible values:
interestBasestring · enumRequired

Method by which interest will be calculated

Example: act365Possible values:
interestIntervalstring · enumRequired

Interest payment interval

Example: annualPossible values:
minimumSettlementUnitstringRequired

Up to what part a bond can be divided

Example: 0,01 unit
settlementUnitMultiplestringRequired

The smallest part of settlement currency to trade

Example: 0,01 EUR
prospectusRegisteredbooleanRequired

Indicator, if the bond prospectus registered

Example: true
preEmptiveRightsbooleanRequired

Indicator, if the bond has pre-emptive rights

Example: true
earlyRedemptionbooleanRequired

Indicator, if the bond can be redeemed early

Example: true
securedbooleanRequired

Indicator, if the bond is secured

Example: true
securedBackingstringOptional

Backing of the secured bond

Example: Gold
issuedAtstring · date-timeRequired

Issue date of the bond.

Example: 2025-10-13T13:47:37.214Z
issuanceRecordAtstring · date-timeRequired

Bond issue record date, from which the coupon accumulation starts.

Example: 2025-10-12T13:47:37.214Z
settleAtstring · date-timeRequired

Date when the bond was or is expected to be fully distributed among initial holders.

Example: 2025-10-26T13:47:37.215Z
maturityRecordAtstring · date-timeRequired

Date when the bond reaches maturity and final owners are fixed.

Example: 2025-12-11T13:47:37.215Z
matureAtstring · date-timeRequired

Date of bond's maturity or simpler, end of bond's lifetime.

Example: 2025-12-12T13:47:37.215Z
referencestringRequired

Reference to the new bond data document or other relevant information.

Example: Bond prospect No. 12345
settlementTypestring · enumRequired

Corporate actions settlement type. It indicates, whether coupon and maturity payments take place within Axiology in EMTs (internal) or via bank/other payments in another environment (external)

Example: externalPossible values:
Responses
201

Successfully created a bond

application/json
post
/bonds
POST /bonds HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1310

{
  "issuerId": "b3ce07c9-a17d-4d0b-9fd7-f734455688c3",
  "currencyId": "f888c2f1-f4dd-45ba-880e-ee5085821c89",
  "name": "Test Bond 1",
  "origin": "native",
  "custodian": "Custodian Bank",
  "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "csdRegisteredAt": "2025-10-13T13:47:37.208Z",
  "underlyingInstrumentCode": "US0378331005",
  "fisn": "FUTURETECH/COMMON STOCK",
  "countryCode": "LT",
  "turnoverType": "public",
  "seniority": "senior-debt",
  "initialPlacement": "public",
  "exponent": 2,
  "isin": "US0378331005",
  "cfi": "DBVUGR",
  "figi": "BBG000BLNNV0",
  "ticker": "AAPL",
  "dti": "BCDFGHJK9",
  "issuePrice": "20 000 USD",
  "totalSupply": 10000,
  "nominalValue": 100,
  "interestRate": "10",
  "interestType": "fixed",
  "interestBase": "act365",
  "interestInterval": "annual",
  "minimumSettlementUnit": "0,01 unit",
  "settlementUnitMultiple": "0,01 EUR",
  "prospectusRegistered": true,
  "preEmptiveRights": true,
  "earlyRedemption": true,
  "secured": true,
  "securedBacking": "Gold",
  "issuedAt": "2025-10-13T13:47:37.214Z",
  "issuanceRecordAt": "2025-10-12T13:47:37.214Z",
  "settleAt": "2025-10-26T13:47:37.215Z",
  "maturityRecordAt": "2025-12-11T13:47:37.215Z",
  "matureAt": "2025-12-12T13:47:37.215Z",
  "coupons": [
    {
      "no": 1,
      "totalPayment": 1000,
      "recordAt": "2025-11-10T13:47:37.163Z",
      "payAt": "2025-12-09T13:47:37.163Z"
    }
  ],
  "reference": "Bond prospect No. 12345",
  "settlementType": "external"
}
201

Successfully created a bond

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "1e5c1b3f-bbcd-4b65-98a4-e8a374d3a337",
  "issuerId": "3b7db38c-9517-4e89-ba36-01e66297e93d",
  "currencyId": "31def7a6-3a8e-4b0c-8232-3781d82c7fce",
  "brokerId": "d951c9f8-3866-448c-9f32-d6900cfd7e2d",
  "origin": "native",
  "custodian": "Custodian Bank",
  "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "csdRegisteredAt": "2034-12-30T00:00:00.000Z",
  "underlyingInstrumentCode": "US0378331005",
  "fisn": "FUTURETECH/COMMON STOCK",
  "countryCode": "LT",
  "turnoverType": "public",
  "seniority": "senior-debt",
  "status": "closed",
  "initialPlacement": "public",
  "issuingAccountAddress": "text",
  "operationalAccountAddress": "text",
  "isin": "US0378331005",
  "cfi": "DBVUGR",
  "figi": "BBG000BLNNV0",
  "ticker": "AAPL",
  "dti": "BCDFGHJK9",
  "issuePrice": "20 000 USD",
  "nominalValue": 10,
  "totalNominalValue": 10000,
  "interestRate": "10",
  "interestType": "fixed",
  "interestBase": "act365",
  "interestInterval": "annual",
  "settlementUnitMultiple": 2,
  "minimumSettlementUnit": 2,
  "prospectusRegistered": true,
  "preEmptiveRights": true,
  "earlyRedemption": true,
  "secured": true,
  "securedBacking": "Gold",
  "issuedAt": "2034-12-30T00:00:00.000Z",
  "issuanceRecordAt": "2034-12-30T00:00:00.000Z",
  "settleAt": "2034-12-30T00:00:00.000Z",
  "maturityRecordAt": "2034-12-30T00:00:00.000Z",
  "matureAt": "2034-12-30T00:00:00.000Z",
  "distributedAmount": 1000,
  "acceptedAmount": 1000,
  "requestedAmount": 1000,
  "collectedAmount": 1000,
  "name": "BOND",
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "exponent": 2,
  "supply": 1000,
  "totalSupply": 1000,
  "couponIds": [
    "36dbd1cc-cc4a-43d0-a166-e3e4cd1380f7"
  ],
  "maturityPaymentIds": [
    "888431dc-1d81-4f6b-9131-475f8d3ee0f8"
  ],
  "distributionIds": [
    "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
  ],
  "supplyChangeIds": [
    "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
  ],
  "dataValidationIds": [
    "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
  ],
  "settlementType": "external"
}

Get bond's auctions

get

Get auctions and their details with status for a single bond

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 548f9000-5696-4921-b008-fdaf43434654
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, startAt, endAt

Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/auctions
GET /bonds/{bondId}/auctions 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": "5a1c82b7-ceb6-489e-94ea-8fa9dd30c63f",
      "brokerId": "6d227435-bae0-4405-b01d-84508b9c90c4",
      "bondId": "23099548-cf92-4a5e-8fcc-f3621be642b9",
      "type": "fixed-price",
      "status": "upcoming",
      "minAmount": 500,
      "price": 100,
      "startAt": "2025-10-26T12:01:29.078Z",
      "endAt": "2025-10-26T12:01:29.078Z",
      "settledAmount": 600,
      "settledTotalPrice": 60000,
      "settledPrice": 100,
      "settledAt": "2025-10-26T12:01:29.078Z"
    }
  ]
}

Create an auction

post

Create an auction that will be held and settled on the chain

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 0b5e757c-0154-4995-8633-d63c4b23018c
Body
typestring · enumRequired

Type of auction

Possible values:
priceinteger · int64Required

Price of a single bond unit, when auction type is 'fixed-price'. Minimal price of a single bond unit, when auction type is 'min-price'

Example: 100
minAmountinteger · int64Required

Minimal amount of bond units that must be auctioned of for auction to be considered successful

Example: 500
startAtstring · date-timeRequired

Date and time when auction opens

Example: 2025-10-17T13:47:37.127Z
endAtstring · date-timeRequired

Date and time when auction closes

Example: 2025-10-22T13:47:37.127Z
Responses
201Success
application/json
post
/bonds/{bondId}/auctions
POST /bonds/{bondId}/auctions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "type": "fixed-price",
  "price": 100,
  "minAmount": 500,
  "startAt": "2025-10-17T13:47:37.127Z",
  "endAt": "2025-10-22T13:47:37.127Z"
}
201Success
{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "5a1c82b7-ceb6-489e-94ea-8fa9dd30c63f",
  "brokerId": "6d227435-bae0-4405-b01d-84508b9c90c4",
  "bondId": "23099548-cf92-4a5e-8fcc-f3621be642b9",
  "type": "fixed-price",
  "status": "upcoming",
  "minAmount": 500,
  "price": 100,
  "startAt": "2025-10-26T12:01:29.078Z",
  "endAt": "2025-10-26T12:01:29.078Z",
  "settledAmount": 600,
  "settledTotalPrice": 60000,
  "settledPrice": 100,
  "settledAt": "2025-10-26T12:01:29.078Z"
}

Get auction

get

Get auction details and status for a bond

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 548f9000-5696-4921-b008-fdaf43434654
auctionIdstring · uuidRequired

Unique UUID of the auction in scope of this gateway

Example: ec76281c-3168-47a0-85ca-8167fe167cab
Responses
200Success
application/json
get
/bonds/{bondId}/auctions/{auctionId}
GET /bonds/{bondId}/auctions/{auctionId} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "5a1c82b7-ceb6-489e-94ea-8fa9dd30c63f",
  "brokerId": "6d227435-bae0-4405-b01d-84508b9c90c4",
  "bondId": "23099548-cf92-4a5e-8fcc-f3621be642b9",
  "type": "fixed-price",
  "status": "upcoming",
  "minAmount": 500,
  "price": 100,
  "startAt": "2025-10-26T12:01:29.078Z",
  "endAt": "2025-10-26T12:01:29.078Z",
  "settledAmount": 600,
  "settledTotalPrice": 60000,
  "settledPrice": 100,
  "settledAt": "2025-10-26T12:01:29.078Z"
}

Cancel auction

patch

Cancel auction that has no active bids

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 0b5e757c-0154-4995-8633-d63c4b23018c
auctionIdstring · uuidRequired

Unique UUID of the auction in scope of this gateway

Example: b9f45611-3a9f-4a6c-8a4c-9be87080723d
Body
statusstring · enumRequiredPossible values:
Responses
200Success
application/json
patch
/bonds/{bondId}/auctions/{auctionId}
PATCH /bonds/{bondId}/auctions/{auctionId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "cancelled"
}
200Success
{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "5a1c82b7-ceb6-489e-94ea-8fa9dd30c63f",
  "brokerId": "6d227435-bae0-4405-b01d-84508b9c90c4",
  "bondId": "23099548-cf92-4a5e-8fcc-f3621be642b9",
  "type": "fixed-price",
  "status": "upcoming",
  "minAmount": 500,
  "price": 100,
  "startAt": "2025-10-26T12:01:29.078Z",
  "endAt": "2025-10-26T12:01:29.078Z",
  "settledAmount": 600,
  "settledTotalPrice": 60000,
  "settledPrice": 100,
  "settledAt": "2025-10-26T12:01:29.078Z"
}

Get all bids

get

Get all bids in the auction

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 9bffe03b-e7e6-44ae-9a6e-9fb6abe91cd6
auctionIdstring · uuidRequired

Unique UUID of the auction in scope of this gateway

Example: 60c6d8ff-7e3b-4af3-a230-d3e540904f42
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:

Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/auctions/{auctionId}/bids
GET /bonds/{bondId}/auctions/{auctionId}/bids 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": "f59b107a-1c89-456c-bacf-3eca74a5db1f",
      "brokerId": "52fbdbf6-d073-4e95-b8f7-fe67410b7f23",
      "bondId": "fd1168fa-b939-4de7-8a73-87247e25f4cc",
      "auctionId": "272f8d73-bf0b-4ebf-aa4b-c4ef889770b2",
      "accountAddress": "text",
      "status": "placed",
      "amount": 20,
      "price": 100,
      "totalPrice": 2000,
      "placedAt": "2025-10-26T12:01:29.078Z",
      "settledAmount": 10,
      "settledTotalPrice": 1000,
      "settledAt": "2025-10-26T12:01:29.078Z"
    }
  ]
}

Create a bid

post

Create a bid on specific auction

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 29d228e3-a9c7-4000-ac20-47d583f21437
auctionIdstring · uuidRequired

Unique UUID of the auction in scope of this gateway

Example: 4029bbaf-74a3-42b5-8888-b26d5a3242c8
Body
accountAddressstringRequired

Account address that is placing a bid

Pattern: r[0-9a-zA-Z]{24,34}
priceinteger · int64Required

price

Example: 100
amountinteger · int64Required

Amount

Example: 10
statusstring · enumOptional

Bids status

Default: placedPossible values:
Responses
201

Created bid

application/json
post
/bonds/{bondId}/auctions/{auctionId}/bids
POST /bonds/{bondId}/auctions/{auctionId}/bids HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "accountAddress": "text",
  "price": 100,
  "amount": 10,
  "status": "placed"
}
201

Created bid

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "f59b107a-1c89-456c-bacf-3eca74a5db1f",
  "brokerId": "52fbdbf6-d073-4e95-b8f7-fe67410b7f23",
  "bondId": "fd1168fa-b939-4de7-8a73-87247e25f4cc",
  "auctionId": "272f8d73-bf0b-4ebf-aa4b-c4ef889770b2",
  "accountAddress": "text",
  "status": "placed",
  "amount": 20,
  "price": 100,
  "totalPrice": 2000,
  "placedAt": "2025-10-26T12:01:29.078Z",
  "settledAmount": 10,
  "settledTotalPrice": 1000,
  "settledAt": "2025-10-26T12:01:29.078Z"
}

Get bid

get

Get auction bid by id

Path parameters
auctionIdstring · uuidRequired

Unique UUID of the auction in scope of this gateway

Example: 60c6d8ff-7e3b-4af3-a230-d3e540904f42
bidIdstring · uuidRequired

Unique UUID of the auction bid in scope of this gateway

bondIdanyRequired

Unique UUID of the bond in scope of this gateway

Example: 9bffe03b-e7e6-44ae-9a6e-9fb6abe91cd6
Responses
200

Auction bid

application/json
get
/bonds/{bondId}/auctions/{auctionId}/bids/{bidId}
GET /bonds/{bondId}/auctions/{auctionId}/bids/{bidId} HTTP/1.1
Host: 
Accept: */*
200

Auction bid

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "f59b107a-1c89-456c-bacf-3eca74a5db1f",
  "brokerId": "52fbdbf6-d073-4e95-b8f7-fe67410b7f23",
  "bondId": "fd1168fa-b939-4de7-8a73-87247e25f4cc",
  "auctionId": "272f8d73-bf0b-4ebf-aa4b-c4ef889770b2",
  "accountAddress": "text",
  "status": "placed",
  "amount": 20,
  "price": 100,
  "totalPrice": 2000,
  "placedAt": "2025-10-26T12:01:29.078Z",
  "settledAmount": 10,
  "settledTotalPrice": 1000,
  "settledAt": "2025-10-26T12:01:29.078Z"
}

Fund/defund/cancel bid

patch

Manage auction bid by funding, defunding or cancelling it

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 29d228e3-a9c7-4000-ac20-47d583f21437
auctionIdstring · uuidRequired

Unique UUID of the auction in scope of this gateway

Example: 4029bbaf-74a3-42b5-8888-b26d5a3242c8
bidIdstring · uuidRequired

Unique UUID of the auction bid in scope of this gateway

Body
statusstring · enumRequired

Status

Default: fundedPossible values:
Responses
200

Changed bid

application/json
patch
/bonds/{bondId}/auctions/{auctionId}/bids/{bidId}
PATCH /bonds/{bondId}/auctions/{auctionId}/bids/{bidId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "funded"
}
200

Changed bid

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "f59b107a-1c89-456c-bacf-3eca74a5db1f",
  "brokerId": "52fbdbf6-d073-4e95-b8f7-fe67410b7f23",
  "bondId": "fd1168fa-b939-4de7-8a73-87247e25f4cc",
  "auctionId": "272f8d73-bf0b-4ebf-aa4b-c4ef889770b2",
  "accountAddress": "text",
  "status": "placed",
  "amount": 20,
  "price": 100,
  "totalPrice": 2000,
  "placedAt": "2025-10-26T12:01:29.078Z",
  "settledAmount": 10,
  "settledTotalPrice": 1000,
  "settledAt": "2025-10-26T12:01:29.078Z"
}

Pay bond coupon in "noFunds" status manually

patch

Pay bond coupon that was not automatically paid because of no funds.

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: eae47c3c-0d7b-4cfa-87da-0d236a6f4813
couponIdstring · uuidRequired

Unique UUID of the coupon in scope of this gateway

Example: 49c2428f-77d7-45ad-85fd-7aa8a58e416c
Responses
200

Coupon paid

application/json
patch
/bonds/{bondId}/coupons/{couponId}
PATCH /bonds/{bondId}/coupons/{couponId} HTTP/1.1
Host: 
Accept: */*
200

Coupon paid

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "0e28265f-fcd5-4066-be6d-3a09d79a52a9",
  "no": 1,
  "bondId": "109e87cf-0e5c-4d5e-9a6e-de8c84d18a51",
  "status": "upcoming",
  "totalPayment": 1000,
  "recordAt": "2025-11-10T13:47:36.113Z",
  "payAt": "2025-12-09T13:47:36.113Z"
}
get

Retrieve a paginated list of bond distributions

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 581a9763-bdaa-44e8-a1fc-333e30d19cc9
Query parameters
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/distributions
GET /bonds/{bondId}/distributions 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": "97193bd5-7514-4ab1-9693-ef0a7df8634b",
      "bondId": "208182c7-e864-4dce-a11a-460fbbe99746",
      "accountAddress": "text",
      "amount": 1000,
      "price": 900,
      "status": "proposed"
    }
  ]
}
post

Create bond distribution.

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 5e9c7474-6628-4317-a7cf-41eea765e857
Bodyobject[]
holderAddressstringRequired

Address of the account to distribute the asset to. Can be both one of this broker's investors or another broker's

Pattern: r[0-9a-zA-Z]{24,34}
bondAmountinteger · int64Required

Amount of bonds to send to the provided receiver

Example: 1000
currencyAmountinteger · int64Required

Price of a single bond to pay for

Example: 900
Responses
201

Successfully created a bond distribution

application/json
post
/bonds/{bondId}/distributions
POST /bonds/{bondId}/distributions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 65

[
  {
    "holderAddress": "text",
    "bondAmount": 1000,
    "currencyAmount": 900
  }
]
201

Successfully created a bond distribution

{
  "totalTxCount": 1,
  "successfulTxCount": 1,
  "failedTxCount": 0
}
get

Retrieve a paginated list of bond maturity payments

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: e562ce7b-94c1-4932-8c8b-37cb7e7e806f
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, status, bondAmount, payoutAmount

Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/maturity-payments
GET /bonds/{bondId}/maturity-payments 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": "d6d7c4ec-3ba7-48b1-9567-6739f4abd13f",
      "status": "completed",
      "bondId": "2cc2eca7-f532-4dd4-9470-bb079c974109",
      "bondAmount": 1000,
      "payoutAmount": 900,
      "receiverAddress": "text",
      "errorMessage": "Something went wrong"
    }
  ]
}
get

Get maturity payment

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: b64288eb-4ae1-4114-ac46-107529aed27b
maturityPaymentIdstring · uuidRequired

Unique UUID of the maturity payment in scope of this gateway

Example: 608da603-a144-4749-acf0-5b4d1967ec13
Responses
200

Retrieve information about single maturity payment

application/json
get
/bonds/{bondId}/maturity-payments/{maturityPaymentId}
GET /bonds/{bondId}/maturity-payments/{maturityPaymentId} HTTP/1.1
Host: 
Accept: */*
200

Retrieve information about single maturity payment

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "d6d7c4ec-3ba7-48b1-9567-6739f4abd13f",
  "status": "completed",
  "bondId": "2cc2eca7-f532-4dd4-9470-bb079c974109",
  "bondAmount": 1000,
  "payoutAmount": 900,
  "receiverAddress": "text",
  "errorMessage": "Something went wrong"
}
patch

Update bond maturity payments for previously failed or no funds holders

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: b5e37882-3691-45ac-8190-11ed9b992b4a
maturityPaymentIdstring · uuidRequired

Unique UUID of the maturity payment in scope of this gateway

Example: 78ce9db3-a3af-4764-9943-7fa075767971
Body
statusstring · enumRequired

Propose/Accept maturity payment

Example: initiatedPossible values:
Responses
200

Successfully received a bond maturity payment

application/json
patch
/bonds/{bondId}/maturity-payments/{maturityPaymentId}
PATCH /bonds/{bondId}/maturity-payments/{maturityPaymentId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "initiated"
}
200

Successfully received a bond maturity payment

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "d6d7c4ec-3ba7-48b1-9567-6739f4abd13f",
  "status": "completed",
  "bondId": "2cc2eca7-f532-4dd4-9470-bb079c974109",
  "bondAmount": 1000,
  "payoutAmount": 900,
  "receiverAddress": "text",
  "errorMessage": "Something went wrong"
}
get

Retrieve a page of price candlesticks from the tradable bond

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 92ac40ea-fe1b-484d-a0ad-d5948853eb2d
lengthstringRequired

Corresponds to the value of candlestick length - trade range in minutes

Example: 5
Query parameters
orderstring · enumOptional

Include/exclude withdrawals with deposits

Example: ascPossible values:
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/prices/{length}
GET /bonds/{bondId}/prices/{length} HTTP/1.1
Host: 
Accept: */*
200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "id": "8f0143fe-4e75-450c-9fde-f1c96ddf00bf",
      "tokenPairId": "83942e35-d2ff-4ba7-a4fa-acbe75a985d3",
      "open": 4,
      "close": 6,
      "low": 3,
      "high": 7,
      "length": 5,
      "candleBegin": "2024-01-01T00:00:00.000Z",
      "candleEnd": "2024-01-01T00:04:99.000Z"
    }
  ]
}
get

Retrieve a list of bond data validation requests available in the system

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 0f9b6b3c-d8e0-46a7-b49c-07732a41a470
Query parameters
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/data-validations
GET /bonds/{bondId}/data-validations 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": "6ae417fc-0abd-44cf-85aa-a6815f6fe35c",
      "bondId": "da9104fc-ebd8-46c1-9997-7e9f76075c5f",
      "status": "initiated",
      "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
      "initiationReference": "Prospect No. 123",
      "validationReference": "Data mismatch",
      "initiatedAt": "2034-12-30T00:00:00.000Z",
      "validatedAt": "2034-12-30T00:00:00.000Z"
    }
  ]
}

Change bond's information

post

Update existing bond's information. This only creates a change request. It is executed only after approval by operator

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 5885a2cf-ded2-4eba-bf5c-920309bde839
Body
issuerIdstring · uuidRequired

Unique UUID of the issuer in scope of this gateway to assign as this bond's issuer

Example: b3ce07c9-a17d-4d0b-9fd7-f734455688c3
currencyIdstring · uuidRequired

Unique UUID of the currency in scope of this gateway provided to set in which currency bond coupon and maturity payments will be executed with

Example: f888c2f1-f4dd-45ba-880e-ee5085821c89
namestringRequired

Full name of the bond

Example: Test Bond 1
originstring · enumRequired

Origin of the bond. Indicates the source of the bond

Default: nativeExample: nativePossible values:
custodianstringOptional

Custodian where asset is registered outside

Example: Custodian Bank
custodianLeiCodestringOptional

LEI code of original depository where the issuer has registered the securities

Example: DG3RU1DBUFHT4ZF9WN62
issuerCsdLeiCodestringOptional

LEI code of the issuer in central securities depository

Example: DG3RU1DBUFHT4ZF9WN62
csdRegisteredAtstring · date-timeOptional

Date of registration in central depository

Example: 2025-10-13T13:47:37.208Z
underlyingInstrumentCodestringOptional

Underlying instrument code

Example: US0378331005
fisnstringOptional

Short description

Example: FUTURETECH/COMMON STOCK
countryCodestringRequired

Country code of where the security is issued

Example: LT
turnoverTypestring · enumOptional

Type of turnover for the bond. Indicates how the bond is traded or transferred

Example: publicPossible values:
senioritystring · enumRequired

Seniority of the bond. Indicates the priority of claims in case of liquidation

Example: senior-debtPossible values:
initialPlacementstring · enumRequired

Initial placement type

Example: publicPossible values:
exponentnumberRequired

Bond exponent - number of fractional decimals allowed for the bond

Example: 2
isinstringOptional

International Securities Identification Number. Code that uniquely identifies a security globally

Example: US0378331005
cfistringOptional

Classification of Financial Instruments. Unique identifier assigned to financial instruments, such as stocks, bonds, derivatives, and other securities

Example: DBVUGR
figistringOptional

Financial Instrument Global Identifier. Code that uniquely identifies a security globally

Example: BBG000BLNNV0
tickerstringOptional

Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes

Example: AAPL
dtistring · iso-24165-dtiOptional

Digital Token Identifier (DTI) as per ISO 24165

Example: BCDFGHJK9Pattern: ^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$
issuePricestringRequired

Price of the bond issue

Example: 20 000 USD
totalSupplyinteger · int64Required

Total amount of bond units that exist or will exist, provided considering exponent of the bond

Example: 10000
nominalValueinteger · int64Required

Nominal/face value of one bond, expressed in chosen currency, provided considering exponent of the currency

Example: 100
interestRatestringRequired

Annual interest rate in % paid for holding this bond

Example: 10
interestTypestring · enumRequired

Interest type. Curently, only fixed interest rate is supported

Example: fixedPossible values:
interestBasestring · enumRequired

Method by which interest will be calculated

Example: act365Possible values:
interestIntervalstring · enumRequired

Interest payment interval

Example: annualPossible values:
minimumSettlementUnitstringRequired

Up to what part a bond can be divided

Example: 0,01 unit
settlementUnitMultiplestringRequired

The smallest part of settlement currency to trade

Example: 0,01 EUR
prospectusRegisteredbooleanRequired

Indicator, if the bond prospectus registered

Example: true
preEmptiveRightsbooleanRequired

Indicator, if the bond has pre-emptive rights

Example: true
earlyRedemptionbooleanRequired

Indicator, if the bond can be redeemed early

Example: true
securedbooleanRequired

Indicator, if the bond is secured

Example: true
securedBackingstringOptional

Backing of the secured bond

Example: Gold
issuedAtstring · date-timeRequired

Issue date of the bond.

Example: 2025-10-13T13:47:37.214Z
issuanceRecordAtstring · date-timeRequired

Bond issue record date, from which the coupon accumulation starts.

Example: 2025-10-12T13:47:37.214Z
settleAtstring · date-timeRequired

Date when the bond was or is expected to be fully distributed among initial holders.

Example: 2025-10-26T13:47:37.215Z
maturityRecordAtstring · date-timeRequired

Date when the bond reaches maturity and final owners are fixed.

Example: 2025-12-11T13:47:37.215Z
matureAtstring · date-timeRequired

Date of bond's maturity or simpler, end of bond's lifetime.

Example: 2025-12-12T13:47:37.215Z
referencestringRequired

Reference to the new bond data document or other relevant information.

Example: Bond prospect No. 12345
settlementTypestring · enumRequired

Corporate actions settlement type. It indicates, whether coupon and maturity payments take place within Axiology in EMTs (internal) or via bank/other payments in another environment (external)

Example: externalPossible values:
Responses
201

Successfully created a request to update bond data

application/json
post
/bonds/{bondId}/data-validations
POST /bonds/{bondId}/data-validations HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1310

{
  "issuerId": "b3ce07c9-a17d-4d0b-9fd7-f734455688c3",
  "currencyId": "f888c2f1-f4dd-45ba-880e-ee5085821c89",
  "name": "Test Bond 1",
  "origin": "native",
  "custodian": "Custodian Bank",
  "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "csdRegisteredAt": "2025-10-13T13:47:37.208Z",
  "underlyingInstrumentCode": "US0378331005",
  "fisn": "FUTURETECH/COMMON STOCK",
  "countryCode": "LT",
  "turnoverType": "public",
  "seniority": "senior-debt",
  "initialPlacement": "public",
  "exponent": 2,
  "isin": "US0378331005",
  "cfi": "DBVUGR",
  "figi": "BBG000BLNNV0",
  "ticker": "AAPL",
  "dti": "BCDFGHJK9",
  "issuePrice": "20 000 USD",
  "totalSupply": 10000,
  "nominalValue": 100,
  "interestRate": "10",
  "interestType": "fixed",
  "interestBase": "act365",
  "interestInterval": "annual",
  "minimumSettlementUnit": "0,01 unit",
  "settlementUnitMultiple": "0,01 EUR",
  "prospectusRegistered": true,
  "preEmptiveRights": true,
  "earlyRedemption": true,
  "secured": true,
  "securedBacking": "Gold",
  "issuedAt": "2025-10-13T13:47:37.214Z",
  "issuanceRecordAt": "2025-10-12T13:47:37.214Z",
  "settleAt": "2025-10-26T13:47:37.215Z",
  "maturityRecordAt": "2025-12-11T13:47:37.215Z",
  "matureAt": "2025-12-12T13:47:37.215Z",
  "coupons": [
    {
      "no": 1,
      "totalPayment": 1000,
      "recordAt": "2025-11-10T13:47:37.163Z",
      "payAt": "2025-12-09T13:47:37.163Z"
    }
  ],
  "reference": "Bond prospect No. 12345",
  "settlementType": "external"
}
201

Successfully created a request to update bond data

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "6ae417fc-0abd-44cf-85aa-a6815f6fe35c",
  "bondId": "da9104fc-ebd8-46c1-9997-7e9f76075c5f",
  "status": "initiated",
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "initiationReference": "Prospect No. 123",
  "validationReference": "Data mismatch",
  "initiatedAt": "2034-12-30T00:00:00.000Z",
  "validatedAt": "2034-12-30T00:00:00.000Z"
}

Cancel bond's information

patch

Cancel existing bond's information that is waiting for operator approval

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 5885a2cf-ded2-4eba-bf5c-920309bde839
dataValidationIdstring · uuidRequired

Unique UUID of the bond data validation request in scope of this gateway

Example: d6537a78-0835-41f4-b13d-606cb2b84ad1
Body
statusstring · enumRequired

Cancel bond data validation

Example: cancelledPossible values:
referencestringRequired

Arbitrary reference provided by the broker to the bond data validation

Example: Mistakes in the document
Responses
200

Successfully cancelled a request to update bond data

application/json
patch
/bonds/{bondId}/data-validations/{dataValidationId}
PATCH /bonds/{bondId}/data-validations/{dataValidationId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "status": "cancelled",
  "reference": "Mistakes in the document"
}
200

Successfully cancelled a request to update bond data

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "6ae417fc-0abd-44cf-85aa-a6815f6fe35c",
  "bondId": "da9104fc-ebd8-46c1-9997-7e9f76075c5f",
  "status": "initiated",
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "initiationReference": "Prospect No. 123",
  "validationReference": "Data mismatch",
  "initiatedAt": "2034-12-30T00:00:00.000Z",
  "validatedAt": "2034-12-30T00:00:00.000Z"
}

Get bond primary distribution

get

Retrieve a bond primary distribution available in the system

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: ff41efce-07f2-45ba-b401-51135faa356e
Responses
200

Retrieved bond primary distribution

application/json
get
/bonds/{bondId}/primary-distributions
GET /bonds/{bondId}/primary-distributions HTTP/1.1
Host: 
Accept: */*
200

Retrieved bond primary distribution

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "0f822c58-1c63-42bf-8047-eeb6b86d2ae8",
  "brokerId": "85dacf40-dbad-44d4-a771-2b97f521e103",
  "bondId": "26a40d57-dbc2-442b-ab1f-c2057c0a3091",
  "type": "fop",
  "supply": 1000,
  "reference": "Stock-split No. 12345",
  "recordedAt": "2025-10-26T12:01:29.078Z",
  "status": "settling"
}

Create primary distribution FOP/DVP

post

Create primary distribution.

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: c48f7738-42ee-441d-8055-74227aca0c7d
Body
typestring · enumRequired

Settlement type

Example: dvpPossible values:
referencestringRequired

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

Example: Primary distribution No. 1
recordedAtstring · date-timeRequired

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

Responses
201

Successfully created a bond primary distribution

application/json
post
/bonds/{bondId}/primary-distributions
POST /bonds/{bondId}/primary-distributions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "type": "dvp",
  "reference": "Primary distribution No. 1",
  "recordedAt": "2025-10-26T12:01:29.078Z",
  "distributees": [
    {
      "accountAddress": "r4tAUXat1Vn5zgqdcfEar3rbfXinJZMkWt",
      "bondAmount": 100,
      "currencyAmount": 100
    },
    {
      "accountAddress": "r44V98mNm5MzYYRY2q1x2Z89xY5x51a65G",
      "bondAmount": 200,
      "currencyAmount": 200
    }
  ]
}
201

Successfully created a bond primary distribution

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "0f822c58-1c63-42bf-8047-eeb6b86d2ae8",
  "brokerId": "85dacf40-dbad-44d4-a771-2b97f521e103",
  "bondId": "26a40d57-dbc2-442b-ab1f-c2057c0a3091",
  "type": "fop",
  "supply": 1000,
  "reference": "Stock-split No. 12345",
  "recordedAt": "2025-10-26T12:01:29.078Z",
  "status": "settling"
}

Retry failed primary distribution FOP

patch

Retry primary distribution for previously failed FOP.

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: d743c2d1-0f48-4a61-8874-9cc2d3676ae0
primaryDistributionIdstring · uuidRequired

Unique UUID of the primary distribution in scope of this gateway

Example: 9e6bb75c-5069-4892-ad4d-8b5427a8e98f
fopIdstring · uuidRequired

Unique UUID of the primary distribution FOP in scope of this gateway

Example: 824d3ed8-aa57-433d-aa20-b11c57687827
Body
statusstring · enumRequired

Initiated/Completed primary distribution FOP

Example: initiatedPossible values:
Responses
200

Successfully retried primary distribution FOP.

application/json
patch
/bonds/{bondId}/primary-distributions/{primaryDistributionId}/fops/{fopId}
PATCH /bonds/{bondId}/primary-distributions/{primaryDistributionId}/fops/{fopId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "initiated"
}
200

Successfully retried primary distribution FOP.

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "d3d2f441-d678-4552-a9c3-35dc96366a64",
  "primaryDistributionId": "b20ccb1f-a17e-43b2-9cde-65562b8fafbb",
  "brokerId": "4d622564-7b5d-4d9d-8949-8b731878bdeb",
  "bondId": "421c0546-5925-4ca2-827e-44aab45678c3",
  "accountAddress": "text",
  "amount": 100,
  "status": "upcoming",
  "settledAt": "2025-10-26T12:01:29.078Z"
}
get

Retrieve a list of bond supply changes requests available in the system

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 95220488-758d-4e9a-bc15-cfeb37c42d67
Query parameters
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/supply-changes
GET /bonds/{bondId}/supply-changes 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": "83397a85-3166-40f8-9106-f08e3b9eaef9",
      "bondId": "9c6b70ab-5cc6-4449-8fc6-dc2432f505a4",
      "status": "initiated",
      "amount": -100,
      "initiationReference": "Prospect No. 123",
      "validationReference": "Data mismatch",
      "initiatedAt": "2034-12-30T00:00:00.000Z",
      "validatedAt": "2034-12-30T00:00:00.000Z"
    }
  ]
}

Change bond's supply

post

Update existing bond's supply. This only creates a change request. It is executed only after approval by operator

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 5b0afa16-2ecc-4ea9-8ef5-ba19cd956081
Body
newSupplyinteger · int64Required

New supply of bond units that is wished to be had on this system, in smallest bond unit (respecting exponent of bond)

Example: 1000
actionstring · enumRequired

Action that is wished to be performed with the bond supply

Example: additionalTokenisationPossible values:
referencestringRequired

Reference to the new bond data document or other relevant information.

Example: Bond prospect No. 12345
Responses
201

Successfully created a request to update bond supply

application/json
post
/bonds/{bondId}/supply-changes
POST /bonds/{bondId}/supply-changes HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "newSupply": 1000,
  "action": "additionalTokenisation",
  "reference": "Bond prospect No. 12345"
}
201

Successfully created a request to update bond supply

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "83397a85-3166-40f8-9106-f08e3b9eaef9",
  "bondId": "9c6b70ab-5cc6-4449-8fc6-dc2432f505a4",
  "status": "initiated",
  "amount": -100,
  "initiationReference": "Prospect No. 123",
  "validationReference": "Data mismatch",
  "initiatedAt": "2034-12-30T00:00:00.000Z",
  "validatedAt": "2034-12-30T00:00:00.000Z"
}

Cancel bond's supply

patch

Cancel existing bond's supply that is waiting for operator approval

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 5294f75b-68db-4a0e-aa50-81dc9b39a902
supplyChangeIdstring · uuidRequired

Unique UUID of the bond supply change request in scope of this gateway

Example: 89621a4e-d9c2-4f50-b665-dc0790035cf4
Body
statusstring · enumRequired

Cancel bond supply change

Example: cancelledPossible values:
referencestringRequired

Arbitrary reference provided by the broker to the bond supply change

Example: Mistakes in the document
Responses
200

Successfully cancelled a request to update bond supply

application/json
patch
/bonds/{bondId}/supply-changes/{supplyChangeId}
PATCH /bonds/{bondId}/supply-changes/{supplyChangeId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "status": "cancelled",
  "reference": "Mistakes in the document"
}
200

Successfully cancelled a request to update bond supply

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "83397a85-3166-40f8-9106-f08e3b9eaef9",
  "bondId": "9c6b70ab-5cc6-4449-8fc6-dc2432f505a4",
  "status": "initiated",
  "amount": -100,
  "initiationReference": "Prospect No. 123",
  "validationReference": "Data mismatch",
  "initiatedAt": "2034-12-30T00:00:00.000Z",
  "validatedAt": "2034-12-30T00:00:00.000Z"
}
get

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

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: b8312877-9270-4b0c-a47f-2c7fb5769bbe
Responses
200

Successfully received a bond

application/json
get
/bonds/{bondId}
GET /bonds/{bondId} HTTP/1.1
Host: 
Accept: */*
200

Successfully received a bond

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "1e5c1b3f-bbcd-4b65-98a4-e8a374d3a337",
  "issuerId": "3b7db38c-9517-4e89-ba36-01e66297e93d",
  "currencyId": "31def7a6-3a8e-4b0c-8232-3781d82c7fce",
  "brokerId": "d951c9f8-3866-448c-9f32-d6900cfd7e2d",
  "origin": "native",
  "custodian": "Custodian Bank",
  "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "csdRegisteredAt": "2034-12-30T00:00:00.000Z",
  "underlyingInstrumentCode": "US0378331005",
  "fisn": "FUTURETECH/COMMON STOCK",
  "countryCode": "LT",
  "turnoverType": "public",
  "seniority": "senior-debt",
  "status": "closed",
  "initialPlacement": "public",
  "issuingAccountAddress": "text",
  "operationalAccountAddress": "text",
  "isin": "US0378331005",
  "cfi": "DBVUGR",
  "figi": "BBG000BLNNV0",
  "ticker": "AAPL",
  "dti": "BCDFGHJK9",
  "issuePrice": "20 000 USD",
  "nominalValue": 10,
  "totalNominalValue": 10000,
  "interestRate": "10",
  "interestType": "fixed",
  "interestBase": "act365",
  "interestInterval": "annual",
  "settlementUnitMultiple": 2,
  "minimumSettlementUnit": 2,
  "prospectusRegistered": true,
  "preEmptiveRights": true,
  "earlyRedemption": true,
  "secured": true,
  "securedBacking": "Gold",
  "issuedAt": "2034-12-30T00:00:00.000Z",
  "issuanceRecordAt": "2034-12-30T00:00:00.000Z",
  "settleAt": "2034-12-30T00:00:00.000Z",
  "maturityRecordAt": "2034-12-30T00:00:00.000Z",
  "matureAt": "2034-12-30T00:00:00.000Z",
  "distributedAmount": 1000,
  "acceptedAmount": 1000,
  "requestedAmount": 1000,
  "collectedAmount": 1000,
  "name": "BOND",
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "exponent": 2,
  "supply": 1000,
  "totalSupply": 1000,
  "couponIds": [
    "36dbd1cc-cc4a-43d0-a166-e3e4cd1380f7"
  ],
  "maturityPaymentIds": [
    "888431dc-1d81-4f6b-9131-475f8d3ee0f8"
  ],
  "distributionIds": [
    "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
  ],
  "supplyChangeIds": [
    "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
  ],
  "dataValidationIds": [
    "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
  ],
  "settlementType": "external"
}
get

Retrieve a list of accounts with balance for specified bond.

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 0ef5b266-0b37-402b-bd6e-c6019818680a
Query parameters
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/accounts
GET /bonds/{bondId}/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": 1000
    }
  ]
}

Get bond coupons

get

Get a paginated list of bonds coupons

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 3cdb2e9d-c4d3-4700-9489-b8d435ee7012
Query parameters
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/coupons
GET /bonds/{bondId}/coupons 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": "0e28265f-fcd5-4066-be6d-3a09d79a52a9",
      "no": 1,
      "bondId": "109e87cf-0e5c-4d5e-9a6e-de8c84d18a51",
      "status": "upcoming",
      "totalPayment": 1000,
      "recordAt": "2025-11-10T13:47:36.113Z",
      "payAt": "2025-12-09T13:47:36.113Z"
    }
  ]
}
get

Retrieve a list of bond coupon payments.

Path parameters
bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: e9e8bf22-652a-4f8c-ad3a-2231ff21a88e
couponIdstring · uuidRequired

Unique UUID of the coupon in scope of this gateway

Example: 343ac699-e4ea-42b7-9b2e-e0236db2d723
Query parameters
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/bonds/{bondId}/coupons/{couponId}/payments
GET /bonds/{bondId}/coupons/{couponId}/payments 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": "e0fcc018-5335-40d2-8bcd-0807798bb5b8",
      "status": "paid",
      "receiverAddress": "r49wKDuk5e7oZNHiY5GtwBeAo7ioGoxoH",
      "bondAmount": 100000,
      "payoutAmount": 1000,
      "couponId": "143ed472-2312-440c-a6e6-87f010a689ca"
    }
  ]
}
PreviousAuctionsNextOrders