Bonds

get

Retrieve a list of bonds available in the system

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:

orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, seniority, status, nominalValue, totalNominalValue, interestRate, secured, issuedAt, issuanceRecordAt, settleAt, maturityRecordAt, matureAt, distributedAmount, requestedAmount, collectedAmount, supply, totalSupply

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds

GET /bonds HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "9183411b-229c-45b7-a258-572ac8f32c01",
      "issuerId": "dc5aaf42-d279-41d5-badf-e375803dde06",
      "currencyId": "5e63fa7d-34e9-4c3f-aa7c-cb8d9aed5cc8",
      "brokerId": "205e9ff3-6de2-4fd6-9831-06feccb9e63c",
      "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": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "operationalAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "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,
      "requestedAmount": 1000,
      "collectedAmount": 1000,
      "name": "BOND",
      "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
      "exponent": 0,
      "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: 1113b96c-40c2-4d1e-9574-405d46b5f470

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: bf8b2ea8-7aa4-45ea-a6e1-3a4222b1ca53

namestringRequired

Full name of the bond

Example: Test Bond 1

originstring · enumRequired

Origin of the bond

Possible 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-12-12T08:55:12.549Z

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

Possible values:

senioritystring · enumRequired

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

Possible values:

initialPlacementstring · enumRequired

Initial placement type

Possible values:

exponentnumber · max: 10Required

Exponent - number of decimal places (scale) used for this asset or currency.

Decimal floating value: stored_value / 10^exponent.
Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).
Examples: 2000 with exponent 2 => 20; 2345 with exponent 3 => 2.345; 2345 with exponent 0 => 2345.

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

Possible values:

interestBasestring · enumRequired

Interest calculation option

Possible values:

interestIntervalstring · enumRequired

Interest payment interval

Possible 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-12-12T08:55:12.550Z

issuanceRecordAtstring · date-timeRequired

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

Example: 2025-12-11T08:55:12.550Z

settleAtstring · date-timeRequired

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

Example: 2025-12-25T08:55:12.551Z

maturityRecordAtstring · date-timeRequired

The official maturity record date and time. Timestamp marking the official maturity record cutoff (typically end of day, e.g. 23:59:59), defining which bondholders are legally entitled to receive principal repayment at maturity according to bond terms/prospectus.

Example: 2026-02-09T08:55:12.551Z

matureAtstring · date-timeRequired

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

Example: 2026-02-10T08:55:12.551Z

referencestringRequired

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

Example: Bond prospect No. 12345

settlementTypestring · enumRequired

Corporate actions settlement type:

internal - payments (coupons, maturity) are settled within Axiology TSS using EMTs
external - payments are settled via bank or other payment systems outside Axiology TSS

Possible values:

Responses

201

Successfully created a bond

application/json

post

/bonds

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

{
  "issuerId": "1113b96c-40c2-4d1e-9574-405d46b5f470",
  "currencyId": "bf8b2ea8-7aa4-45ea-a6e1-3a4222b1ca53",
  "name": "Test Bond 1",
  "origin": "native",
  "custodian": "Custodian Bank",
  "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "csdRegisteredAt": "2025-12-12T08:55:12.549Z",
  "underlyingInstrumentCode": "US0378331005",
  "fisn": "FUTURETECH/COMMON STOCK",
  "countryCode": "LT",
  "turnoverType": "public",
  "seniority": "senior-debt",
  "initialPlacement": "public",
  "exponent": 0,
  "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-12-12T08:55:12.550Z",
  "issuanceRecordAt": "2025-12-11T08:55:12.550Z",
  "settleAt": "2025-12-25T08:55:12.551Z",
  "maturityRecordAt": "2026-02-09T08:55:12.551Z",
  "matureAt": "2026-02-10T08:55:12.551Z",
  "coupons": [
    {
      "no": 1,
      "totalPayment": 1000,
      "recordAt": "2026-01-09T08:55:12.451Z",
      "payAt": "2026-02-07T08:55:12.451Z"
    }
  ],
  "reference": "Bond prospect No. 12345",
  "settlementType": "external"
}

201

Successfully created a bond

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "9183411b-229c-45b7-a258-572ac8f32c01",
  "issuerId": "dc5aaf42-d279-41d5-badf-e375803dde06",
  "currencyId": "5e63fa7d-34e9-4c3f-aa7c-cb8d9aed5cc8",
  "brokerId": "205e9ff3-6de2-4fd6-9831-06feccb9e63c",
  "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": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "operationalAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "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,
  "requestedAmount": 1000,
  "collectedAmount": 1000,
  "name": "BOND",
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "exponent": 0,
  "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:

orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, startAt, endAt

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/auctions

GET /bonds/{bondId}/auctions HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "2f4b29b9-ef14-4f7c-bbd8-e4160b64590e",
      "brokerId": "babbfcb4-7843-49aa-8d94-21e0d072a0f5",
      "assetId": "d844e687-bb8e-4d64-b408-19bcfc301e26",
      "type": "fixed-price",
      "status": "upcoming",
      "minAmount": 500,
      "price": 100,
      "startAt": "2026-03-22T02:47:05.633Z",
      "endAt": "2026-03-22T02:47:05.633Z",
      "settledAmount": 600,
      "settledTotalPrice": 60000,
      "settledPrice": 100,
      "settledAt": "2026-03-22T02:47:05.633Z"
    }
  ]
}

Create an auction

post

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

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Body

typestring · enumRequired

Type of auction:

'fixed-price' - price is fixed
'min-price' - price is limited to lower boundary, inclusive

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-12-16T08:55:12.285Z

endAtstring · date-timeRequired

Date and time when auction closes

Example: 2025-12-21T08:55:12.285Z

Responses

201Success

application/json

post

/bonds/{bondId}/auctions

POST /bonds/{bondId}/auctions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "type": "fixed-price",
  "price": 100,
  "minAmount": 500,
  "startAt": "2025-12-16T08:55:12.285Z",
  "endAt": "2025-12-21T08:55:12.285Z"
}

201Success

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "2f4b29b9-ef14-4f7c-bbd8-e4160b64590e",
  "brokerId": "babbfcb4-7843-49aa-8d94-21e0d072a0f5",
  "assetId": "d844e687-bb8e-4d64-b408-19bcfc301e26",
  "type": "fixed-price",
  "status": "upcoming",
  "minAmount": 500,
  "price": 100,
  "startAt": "2026-03-22T02:47:05.633Z",
  "endAt": "2026-03-22T02:47:05.633Z",
  "settledAmount": 600,
  "settledTotalPrice": 60000,
  "settledPrice": 100,
  "settledAt": "2026-03-22T02:47:05.633Z"
}

Get auction

get

Get auction details and status for a bond

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

auctionIdstring · uuidRequired

Auction UUID identifier, unique in scope of this node

Example: 57c03592-9de8-4e7b-803e-a9c84fbc98e1

Responses

200Success

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Auction id

Example: 2f4b29b9-ef14-4f7c-bbd8-e4160b64590e

brokerIdstring · uuidRequired

Broker id

Example: babbfcb4-7843-49aa-8d94-21e0d072a0f5

assetIdstring · uuidRequired

Asset id

Example: d844e687-bb8e-4d64-b408-19bcfc301e26

typestring · enumRequired

Type of auction:

'fixed-price' - price is fixed
'min-price' - price is limited to lower boundary, inclusive

Possible values:

statusstring · enumRequired

Auction status:

upcoming - will open in the future
open - currently open and accepts bids
closed - successful, but not yet settled
settled - successful and settled
failed - unsuccessful auction, minAmount not reached
cancelled - cancelled by issuer agent

Possible values:

minAmountinteger · int64Required

Minimal amount that needs to be auctioned off for auction to succeed

Example: 500

priceinteger · int64Required

Minimal or fixed price, determined by auction type

Example: 100

startAtstring · date-timeRequired

Date and time of auction opening

endAtstring · date-timeRequired

Date and time of auction closing

settledAmountinteger · int64 · nullableRequired

Total settled amount

Example: 600

settledTotalPriceinteger · int64 · nullableRequired

Settled total price

Example: 60000

settledPriceinteger · int64 · nullableRequired

Settled price per unit

Example: 100

settledAtstring · date-time · nullableRequired

Date and time of auction settlement

get

/bonds/{bondId}/auctions/{auctionId}

GET /bonds/{bondId}/auctions/{auctionId} HTTP/1.1
Accept: */*

200Success

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "2f4b29b9-ef14-4f7c-bbd8-e4160b64590e",
  "brokerId": "babbfcb4-7843-49aa-8d94-21e0d072a0f5",
  "assetId": "d844e687-bb8e-4d64-b408-19bcfc301e26",
  "type": "fixed-price",
  "status": "upcoming",
  "minAmount": 500,
  "price": 100,
  "startAt": "2026-03-22T02:47:05.633Z",
  "endAt": "2026-03-22T02:47:05.633Z",
  "settledAmount": 600,
  "settledTotalPrice": 60000,
  "settledPrice": 100,
  "settledAt": "2026-03-22T02:47:05.633Z"
}

Cancel auction

patch

Cancel auction that has no active bids

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

auctionIdstring · uuidRequired

Auction UUID identifier, unique in scope of this node

Example: 57c03592-9de8-4e7b-803e-a9c84fbc98e1

Body

statusstring · enumRequired

Auction status:

upcoming - will open in the future
open - currently open and accepts bids
closed - successful, but not yet settled
settled - successful and settled
failed - unsuccessful auction, minAmount not reached
cancelled - cancelled by issuer agent

Possible values:

Responses

200Success

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Auction id

Example: 2f4b29b9-ef14-4f7c-bbd8-e4160b64590e

brokerIdstring · uuidRequired

Broker id

Example: babbfcb4-7843-49aa-8d94-21e0d072a0f5

assetIdstring · uuidRequired

Asset id

Example: d844e687-bb8e-4d64-b408-19bcfc301e26

typestring · enumRequired

Type of auction:

'fixed-price' - price is fixed
'min-price' - price is limited to lower boundary, inclusive

Possible values:

statusstring · enumRequired

Auction status:

upcoming - will open in the future
open - currently open and accepts bids
closed - successful, but not yet settled
settled - successful and settled
failed - unsuccessful auction, minAmount not reached
cancelled - cancelled by issuer agent

Possible values:

minAmountinteger · int64Required

Minimal amount that needs to be auctioned off for auction to succeed

Example: 500

priceinteger · int64Required

Minimal or fixed price, determined by auction type

Example: 100

startAtstring · date-timeRequired

Date and time of auction opening

endAtstring · date-timeRequired

Date and time of auction closing

settledAmountinteger · int64 · nullableRequired

Total settled amount

Example: 600

settledTotalPriceinteger · int64 · nullableRequired

Settled total price

Example: 60000

settledPriceinteger · int64 · nullableRequired

Settled price per unit

Example: 100

settledAtstring · date-time · nullableRequired

Date and time of auction settlement

patch

/bonds/{bondId}/auctions/{auctionId}

PATCH /bonds/{bondId}/auctions/{auctionId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "cancelled"
}

200Success

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "2f4b29b9-ef14-4f7c-bbd8-e4160b64590e",
  "brokerId": "babbfcb4-7843-49aa-8d94-21e0d072a0f5",
  "assetId": "d844e687-bb8e-4d64-b408-19bcfc301e26",
  "type": "fixed-price",
  "status": "upcoming",
  "minAmount": 500,
  "price": 100,
  "startAt": "2026-03-22T02:47:05.633Z",
  "endAt": "2026-03-22T02:47:05.633Z",
  "settledAmount": 600,
  "settledTotalPrice": 60000,
  "settledPrice": 100,
  "settledAt": "2026-03-22T02:47:05.633Z"
}

Get all bids

get

Get all bids in the auction

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

auctionIdstring · uuidRequired

Auction UUID identifier, unique in scope of this node

Example: 57c03592-9de8-4e7b-803e-a9c84fbc98e1

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:

orderanyOptional

Array of fields and directions to order. Supported fields:

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/auctions/{auctionId}/bids

GET /bonds/{bondId}/auctions/{auctionId}/bids HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "270a4970-6aec-403c-957f-275f0e61a054",
      "brokerId": "28eca6a2-79ea-480e-bc6a-fb926306f4fd",
      "assetId": "a2186858-e9e3-46fa-abc2-5eb86cbd5795",
      "auctionId": "a07ea8a0-4981-4a39-9e02-9d1807686897",
      "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "status": "placed",
      "amount": 20,
      "price": 100,
      "totalPrice": 2000,
      "placedAt": "2026-03-22T02:47:05.633Z",
      "settledAmount": 10,
      "settledTotalPrice": 1000,
      "settledAt": "2026-03-22T02:47:05.633Z"
    }
  ]
}

Create a bid

post

Create a bid on specific auction

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

auctionIdstring · uuidRequired

Auction UUID identifier, unique in scope of this node

Example: 57c03592-9de8-4e7b-803e-a9c84fbc98e1

Body

accountAddressstring · xrp-addressRequired

Account address that is placing a bid

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

priceinteger · int64Required

price

Example: 100

amountinteger · int64Required

Amount

Example: 10

statusstring · enumOptional

Create bid status:

placed - place unfunded bid
funded - place funded bid

Possible values:

Responses

201

Created bid

application/json

post

/bonds/{bondId}/auctions/{auctionId}/bids

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

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

201

Created bid

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "270a4970-6aec-403c-957f-275f0e61a054",
  "brokerId": "28eca6a2-79ea-480e-bc6a-fb926306f4fd",
  "assetId": "a2186858-e9e3-46fa-abc2-5eb86cbd5795",
  "auctionId": "a07ea8a0-4981-4a39-9e02-9d1807686897",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "status": "placed",
  "amount": 20,
  "price": 100,
  "totalPrice": 2000,
  "placedAt": "2026-03-22T02:47:05.633Z",
  "settledAmount": 10,
  "settledTotalPrice": 1000,
  "settledAt": "2026-03-22T02:47:05.633Z"
}

Get bid

get

Get auction bid by id

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

auctionIdstring · uuidRequired

Auction UUID identifier, unique in scope of this node

Example: 57c03592-9de8-4e7b-803e-a9c84fbc98e1

bidIdstring · uuidRequired

Bid UUID identifier, globally unique to Axiology TSS

Example: 12d3666b-09e0-4ca8-b4f6-49a00fc5d810

Responses

200

Auction bid

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Unique UUID of Auction bid in scope of this node

Example: 270a4970-6aec-403c-957f-275f0e61a054

brokerIdstring · uuidRequired

Broker UUID that placed the bid

Example: 28eca6a2-79ea-480e-bc6a-fb926306f4fd

assetIdstring · uuidRequired

Asset UUID that the bid is for

Example: a2186858-e9e3-46fa-abc2-5eb86cbd5795

auctionIdstring · uuidRequired

Auction UUID that the bid is for

Example: a07ea8a0-4981-4a39-9e02-9d1807686897

accountAddressstring · xrp-addressRequired

Account address that placed the bid

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

statusstring · enumRequired

Create bid status:

placed - place unfunded bid
funded - place funded bid

Possible values:

amountinteger · int64Required

Bond amount the bid is for

Example: 20

priceinteger · int64Required

Bond price per unit

Example: 100

totalPriceinteger · int64Required

Total bid price

Example: 2000

placedAtstring · date-time · nullableRequired

Bid placement time

settledAmountinteger · int64 · nullableRequired

Settled amount the bid is for

Example: 10

settledTotalPriceinteger · int64 · nullableRequired

Settled total price

Example: 1000

settledAtstring · date-time · nullableRequired

Bid settlement time

get

/bonds/{bondId}/auctions/{auctionId}/bids/{bidId}

GET /bonds/{bondId}/auctions/{auctionId}/bids/{bidId} HTTP/1.1
Accept: */*

200

Auction bid

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "270a4970-6aec-403c-957f-275f0e61a054",
  "brokerId": "28eca6a2-79ea-480e-bc6a-fb926306f4fd",
  "assetId": "a2186858-e9e3-46fa-abc2-5eb86cbd5795",
  "auctionId": "a07ea8a0-4981-4a39-9e02-9d1807686897",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "status": "placed",
  "amount": 20,
  "price": 100,
  "totalPrice": 2000,
  "placedAt": "2026-03-22T02:47:05.633Z",
  "settledAmount": 10,
  "settledTotalPrice": 1000,
  "settledAt": "2026-03-22T02:47:05.633Z"
}

Fund/defund/cancel bid

patch

Manage auction bid by funding, defunding or cancelling it

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

auctionIdstring · uuidRequired

Auction UUID identifier, unique in scope of this node

Example: 57c03592-9de8-4e7b-803e-a9c84fbc98e1

bidIdstring · uuidRequired

Bid UUID identifier, globally unique to Axiology TSS

Example: 12d3666b-09e0-4ca8-b4f6-49a00fc5d810

Body

statusstring · enumRequired

Create bid status:

placed - place unfunded bid
funded - place funded bid

Possible values:

Responses

200

Changed bid

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Unique UUID of Auction bid in scope of this node

Example: 270a4970-6aec-403c-957f-275f0e61a054

brokerIdstring · uuidRequired

Broker UUID that placed the bid

Example: 28eca6a2-79ea-480e-bc6a-fb926306f4fd

assetIdstring · uuidRequired

Asset UUID that the bid is for

Example: a2186858-e9e3-46fa-abc2-5eb86cbd5795

auctionIdstring · uuidRequired

Auction UUID that the bid is for

Example: a07ea8a0-4981-4a39-9e02-9d1807686897

accountAddressstring · xrp-addressRequired

Account address that placed the bid

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

statusstring · enumRequired

Create bid status:

placed - place unfunded bid
funded - place funded bid

Possible values:

amountinteger · int64Required

Bond amount the bid is for

Example: 20

priceinteger · int64Required

Bond price per unit

Example: 100

totalPriceinteger · int64Required

Total bid price

Example: 2000

placedAtstring · date-time · nullableRequired

Bid placement time

settledAmountinteger · int64 · nullableRequired

Settled amount the bid is for

Example: 10

settledTotalPriceinteger · int64 · nullableRequired

Settled total price

Example: 1000

settledAtstring · date-time · nullableRequired

Bid settlement time

patch

/bonds/{bondId}/auctions/{auctionId}/bids/{bidId}

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

{
  "status": "funded"
}

200

Changed bid

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "270a4970-6aec-403c-957f-275f0e61a054",
  "brokerId": "28eca6a2-79ea-480e-bc6a-fb926306f4fd",
  "assetId": "a2186858-e9e3-46fa-abc2-5eb86cbd5795",
  "auctionId": "a07ea8a0-4981-4a39-9e02-9d1807686897",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "status": "placed",
  "amount": 20,
  "price": 100,
  "totalPrice": 2000,
  "placedAt": "2026-03-22T02:47:05.633Z",
  "settledAmount": 10,
  "settledTotalPrice": 1000,
  "settledAt": "2026-03-22T02:47:05.633Z"
}

Pay bond coupon manually

patch

Pay bond coupon that was not automatically paid

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

couponIdstring · uuidRequired

Coupon UUID identifier, unique in scope of this node

Example: b5abc81b-8412-4949-a352-b6c90286b09b

Responses

200

Coupon paid

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Coupon UUID, unique in scope of this node

Example: fb4702b8-32d6-4e17-8d81-306dd637dcc1

nonumberRequired

Coupon №

Example: 1

bondIdstring · uuidRequired

Bond UUID, unique in scope of this node

Example: 052c31bc-c782-486d-ae95-438a954164e4

statusstring · enumRequired

Coupon status

Possible values:

totalPaymentinteger · int64Required

Total payment of coupon in smallest currency unit (respecting exponent of bond currency)

Example: 1000

recordAtstring · date-timeRequired

Date of coupon's period end, bond holders are recorded.

Example: 2026-01-09T08:55:11.550Z

payAtstring · date-timeRequired

Date of coupon's payment, must be later than record date.

Example: 2026-02-07T08:55:11.550Z

patch

/bonds/{bondId}/coupons/{couponId}

PATCH /bonds/{bondId}/coupons/{couponId} HTTP/1.1
Accept: */*

200

Coupon paid

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "fb4702b8-32d6-4e17-8d81-306dd637dcc1",
  "no": 1,
  "bondId": "052c31bc-c782-486d-ae95-438a954164e4",
  "status": "upcoming",
  "totalPayment": 1000,
  "recordAt": "2026-01-09T08:55:11.550Z",
  "payAt": "2026-02-07T08:55:11.550Z"
}

Deprecated

get

Retrieve a paginated list of bond distributions

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/distributions

GET /bonds/{bondId}/distributions HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "30139970-74c9-4bd7-813a-4449ec5553bb",
      "bondId": "1735c7a7-1709-4524-b95a-3c91c9caf338",
      "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "amount": 1000,
      "price": 900,
      "status": "proposed"
    }
  ]
}

Deprecated

post

Create bond distribution.

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Bodyobject[]

holderAddressstring · xrp-addressRequired

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

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: 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
Content-Type: application/json
Accept: */*
Content-Length: 95

[
  {
    "holderAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible 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

get

/bonds/{bondId}/maturity-payments

GET /bonds/{bondId}/maturity-payments HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "907252a0-803e-4824-ad78-f125f6b7508a",
      "status": "completed",
      "bondId": "4f41aa47-e4bb-4849-81f0-60f0223b62ba",
      "bondAmount": 1000,
      "payoutAmount": 900,
      "receiverAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "errorMessage": "Something went wrong"
    }
  ]
}

get

Get maturity payment

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

maturityPaymentIdstring · uuidRequired

Maturity Payment UUID identifier, unique in scope of this node

Example: 616b7611-fcc4-48f2-80b8-bd90d5fd6d11

Responses

200

Retrieve information about single maturity payment

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Unique UUID of the maturity payment in scope of this gateway

Example: 907252a0-803e-4824-ad78-f125f6b7508a

statusstring · enumRequired

Status of the maturity payment

Possible values:

bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 4f41aa47-e4bb-4849-81f0-60f0223b62ba

bondAmountinteger · int64Required

Bond amount for this maturity payment

Example: 1000

payoutAmountinteger · int64Required

Amount to pay for this maturity payment

Example: 900

receiverAddressstring · xrp-addressRequired

Payment`s receiver address corresponding to the investor account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

errorMessagestringOptional

Error message

Example: Something went wrong

get

/bonds/{bondId}/maturity-payments/{maturityPaymentId}

GET /bonds/{bondId}/maturity-payments/{maturityPaymentId} HTTP/1.1
Accept: */*

200

Retrieve information about single maturity payment

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "907252a0-803e-4824-ad78-f125f6b7508a",
  "status": "completed",
  "bondId": "4f41aa47-e4bb-4849-81f0-60f0223b62ba",
  "bondAmount": 1000,
  "payoutAmount": 900,
  "receiverAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "errorMessage": "Something went wrong"
}

patch

Update bond maturity payments for previously failed or no funds holders

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

maturityPaymentIdstring · uuidRequired

Maturity Payment UUID identifier, unique in scope of this node

Example: 616b7611-fcc4-48f2-80b8-bd90d5fd6d11

Body

statusstring · enumRequired

Status of the maturity payment

Possible values:

Responses

200

Successfully received a bond maturity payment

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Unique UUID of the maturity payment in scope of this gateway

Example: 907252a0-803e-4824-ad78-f125f6b7508a

statusstring · enumRequired

Status of the maturity payment

Possible values:

bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 4f41aa47-e4bb-4849-81f0-60f0223b62ba

bondAmountinteger · int64Required

Bond amount for this maturity payment

Example: 1000

payoutAmountinteger · int64Required

Amount to pay for this maturity payment

Example: 900

receiverAddressstring · xrp-addressRequired

Payment`s receiver address corresponding to the investor account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

errorMessagestringOptional

Error message

Example: Something went wrong

patch

/bonds/{bondId}/maturity-payments/{maturityPaymentId}

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

{
  "status": "initiated"
}

200

Successfully received a bond maturity payment

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "907252a0-803e-4824-ad78-f125f6b7508a",
  "status": "completed",
  "bondId": "4f41aa47-e4bb-4849-81f0-60f0223b62ba",
  "bondAmount": 1000,
  "payoutAmount": 900,
  "receiverAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "errorMessage": "Something went wrong"
}

Deprecated

get

Retrieve a page of price candlesticks from the tradable bond

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

lengthnumberRequired

Length of the candlestick 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

get

/bonds/{bondId}/prices/{length}

GET /bonds/{bondId}/prices/{length} HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "created_at": "2026-03-22T02:47:05.633Z",
      "updated_at": "2026-03-22T02:47:05.633Z",
      "id": "b5071339-758f-4579-ac72-ce671b4bb939",
      "tokenPairId": "3250d835-38eb-4387-a066-9d095cc55f2b",
      "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/data-validations

GET /bonds/{bondId}/data-validations HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "e687f2ad-74fa-49ea-95d0-88e8a23dedb7",
      "bondId": "e2ed88fb-1ac9-4904-b84e-ecc933200d18",
      "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Body

issuerIdstring · uuidRequired

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

Example: 1113b96c-40c2-4d1e-9574-405d46b5f470

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: bf8b2ea8-7aa4-45ea-a6e1-3a4222b1ca53

namestringRequired

Full name of the bond

Example: Test Bond 1

originstring · enumRequired

Origin of the bond

Possible 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-12-12T08:55:12.549Z

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

Possible values:

senioritystring · enumRequired

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

Possible values:

initialPlacementstring · enumRequired

Initial placement type

Possible values:

exponentnumber · max: 10Required

Exponent - number of decimal places (scale) used for this asset or currency.

Decimal floating value: stored_value / 10^exponent.
Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).
Examples: 2000 with exponent 2 => 20; 2345 with exponent 3 => 2.345; 2345 with exponent 0 => 2345.

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

Possible values:

interestBasestring · enumRequired

Interest calculation option

Possible values:

interestIntervalstring · enumRequired

Interest payment interval

Possible 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-12-12T08:55:12.550Z

issuanceRecordAtstring · date-timeRequired

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

Example: 2025-12-11T08:55:12.550Z

settleAtstring · date-timeRequired

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

Example: 2025-12-25T08:55:12.551Z

maturityRecordAtstring · date-timeRequired

Example: 2026-02-09T08:55:12.551Z

matureAtstring · date-timeRequired

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

Example: 2026-02-10T08:55:12.551Z

referencestringRequired

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

Example: Bond prospect No. 12345

settlementTypestring · enumRequired

Corporate actions settlement type:

internal - payments (coupons, maturity) are settled within Axiology TSS using EMTs
external - payments are settled via bank or other payment systems outside Axiology TSS

Possible 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
Content-Type: application/json
Accept: */*
Content-Length: 1310

{
  "issuerId": "1113b96c-40c2-4d1e-9574-405d46b5f470",
  "currencyId": "bf8b2ea8-7aa4-45ea-a6e1-3a4222b1ca53",
  "name": "Test Bond 1",
  "origin": "native",
  "custodian": "Custodian Bank",
  "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
  "csdRegisteredAt": "2025-12-12T08:55:12.549Z",
  "underlyingInstrumentCode": "US0378331005",
  "fisn": "FUTURETECH/COMMON STOCK",
  "countryCode": "LT",
  "turnoverType": "public",
  "seniority": "senior-debt",
  "initialPlacement": "public",
  "exponent": 0,
  "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-12-12T08:55:12.550Z",
  "issuanceRecordAt": "2025-12-11T08:55:12.550Z",
  "settleAt": "2025-12-25T08:55:12.551Z",
  "maturityRecordAt": "2026-02-09T08:55:12.551Z",
  "matureAt": "2026-02-10T08:55:12.551Z",
  "coupons": [
    {
      "no": 1,
      "totalPayment": 1000,
      "recordAt": "2026-01-09T08:55:12.451Z",
      "payAt": "2026-02-07T08:55:12.451Z"
    }
  ],
  "reference": "Bond prospect No. 12345",
  "settlementType": "external"
}

201

Successfully created a request to update bond data

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "e687f2ad-74fa-49ea-95d0-88e8a23dedb7",
  "bondId": "e2ed88fb-1ac9-4904-b84e-ecc933200d18",
  "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

dataValidationIdstring · uuidRequired

Data validation UUID identifier, unique in scope of this node

Example: ab8eaebf-559e-42e7-ad60-d13c43d10803

Body

statusstring · enumRequired

Status of bond data validation

Possible 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

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

UUIDv4 of the bond data validation request

Example: e687f2ad-74fa-49ea-95d0-88e8a23dedb7

bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: e2ed88fb-1ac9-4904-b84e-ecc933200d18

statusstring · enumRequired

Status of bond data validation

Possible values:

ipfsLinkstringRequired

IPFS link with bond data that was validated or needs to be validated

Example: /ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo

initiationReferencestringRequired

Reference provided by the broker during bond data validation initiation

Example: Prospect No. 123

validationReferencestring · nullableRequired

Reference provided by the operator during bond data validation

Example: Data mismatch

initiatedAtstring · date-timeRequired

Date when the bond data validation was initiated

Example: 2034-12-30T00:00:00.000Z

validatedAtstring · date-time · nullableRequired

Date when the bond data validation was completed

Example: 2034-12-30T00:00:00.000Z

patch

/bonds/{bondId}/data-validations/{dataValidationId}

PATCH /bonds/{bondId}/data-validations/{dataValidationId} HTTP/1.1
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": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "e687f2ad-74fa-49ea-95d0-88e8a23dedb7",
  "bondId": "e2ed88fb-1ac9-4904-b84e-ecc933200d18",
  "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 distributions

get

Get a paginated list of distributions for a specific bond

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

Responses

200

Successfully retrieved a list of bond distributions.

application/json

get

/bonds/{bondId}/primary-distributions

GET /bonds/{bondId}/primary-distributions HTTP/1.1
Accept: */*

200

Successfully retrieved a list of bond distributions.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "b006212e-9da8-44a4-9be3-9e6e833e7834",
      "brokerId": "0cf7f3d7-5641-4973-a85b-6c92baef0026",
      "bondId": "7cba0d0f-008a-4c53-b4ac-220305e2b9d3",
      "type": "dvp",
      "supply": 1000,
      "reference": "Stock-split No. 12345",
      "recordedAt": "2026-03-22T02:47:05.633Z",
      "status": "settling"
    }
  ]
}

Distribute bond

post

Initiate bond distribution via Free Of Payment or Delivery Versus Payment method

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Body

typestring · enumRequired

Settlement type

Possible 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 distribution of a bond

application/json

post

/bonds/{bondId}/primary-distributions

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

{
  "type": "dvp",
  "reference": "Primary distribution No. 1",
  "recordedAt": "2026-03-22T02:47:05.633Z",
  "distributees": [
    {
      "accountAddress": "r4tAUXat1Vn5zgqdcfEar3rbfXinJZMkWt",
      "bondAmount": 100,
      "currencyAmount": 100
    },
    {
      "accountAddress": "r44V98mNm5MzYYRY2q1x2Z89xY5x51a65G",
      "bondAmount": 200,
      "currencyAmount": 200
    }
  ]
}

201

Successfully created distribution of a bond

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "b006212e-9da8-44a4-9be3-9e6e833e7834",
  "brokerId": "0cf7f3d7-5641-4973-a85b-6c92baef0026",
  "bondId": "7cba0d0f-008a-4c53-b4ac-220305e2b9d3",
  "type": "dvp",
  "supply": 1000,
  "reference": "Stock-split No. 12345",
  "recordedAt": "2026-03-22T02:47:05.633Z",
  "status": "settling"
}

Retry failed primary distribution FOP

patch

Retry primary distribution for previously failed FOP.

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

primaryDistributionIdstring · uuidRequired

Primary Distribution UUID identifier, unique in scope of this node

Example: 2c48f7f9-220b-47e1-8426-0481c9d5ddf0

fopIdstring · uuidRequired

FOP UUID identifier, unique in scope of this node

Example: 123491c6-47ab-4db9-90d9-ec5495e80864

Body

statusstring · enumRequired

Update primary distribution FOP status

initiated - (issuer agent) initiate upcoming or initiation-failed FOP distribution
completed - (investor agent) complete initiated FOP distribution

Possible values:

Responses

200

Successfully retried primary distribution FOP.

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Primary distribution FOP id

Example: ef6df23e-52d6-4b37-98c8-72373bccac1a

primaryDistributionIdstring · uuidRequired

Primary distribution id

Example: 9750277b-bb32-456e-bf85-27e6bb0c4a3f

bondIdstring · uuidRequired

Bond id

Example: 8ca923ae-70cc-459d-b909-586e208735cc

accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

amountinteger · int64Required

Amount to receive

Example: 100

statusstring · enumRequired

Update primary distribution FOP status

initiated - (issuer agent) initiate upcoming or initiation-failed FOP distribution
completed - (investor agent) complete initiated FOP distribution

Possible values:

settledAtstring · date-timeRequired

Date and time of primary distribution FOP

patch

/bonds/{bondId}/primary-distributions/{primaryDistributionId}/fops/{fopId}

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

{
  "status": "initiated"
}

200

Successfully retried primary distribution FOP.

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "ef6df23e-52d6-4b37-98c8-72373bccac1a",
  "primaryDistributionId": "9750277b-bb32-456e-bf85-27e6bb0c4a3f",
  "bondId": "8ca923ae-70cc-459d-b909-586e208735cc",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "amount": 100,
  "status": "initiated",
  "settledAt": "2026-03-22T02:47:05.633Z"
}

get

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

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/supply-changes

GET /bonds/{bondId}/supply-changes HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "e74ce006-cfd2-4e32-9dac-b27b0a4c3778",
      "bondId": "3756a24c-589e-452e-b04d-953d358d07f2",
      "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

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

Possible 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
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": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "e74ce006-cfd2-4e32-9dac-b27b0a4c3778",
  "bondId": "3756a24c-589e-452e-b04d-953d358d07f2",
  "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

supplyChangeIdstring · uuidRequired

Supply Change UUID identifier, unique in scope of this gateway

Example: 78e344e2-5e0b-4c9e-9a24-b7a078f03bb3

Body

statusstring · enumRequired

Status of bond supply change request

Possible values:

referencestringRequired

Arbitrary reference provided by the issuer agent to the bond supply change

Example: Mistakes in the document

Responses

200

Successfully cancelled a request to update bond supply

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

UUIDv4 of the bond supply change request

Example: e74ce006-cfd2-4e32-9dac-b27b0a4c3778

bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: 3756a24c-589e-452e-b04d-953d358d07f2

statusstring · enumRequired

Status of bond supply change request

Possible values:

amountinteger · int64Required

Amount change in bond supply requested

Example: -100

initiationReferencestringRequired

Reference provided by the broker during bond supply change initiation

Example: Prospect No. 123

validationReferencestring · nullableRequired

Reference provided by the operator during bond supply change validation

Example: Data mismatch

initiatedAtstring · date-timeRequired

Date when the bond supply change was initiated

Example: 2034-12-30T00:00:00.000Z

validatedAtstring · date-time · nullableRequired

Date when the bond supply change was validated

Example: 2034-12-30T00:00:00.000Z

patch

/bonds/{bondId}/supply-changes/{supplyChangeId}

PATCH /bonds/{bondId}/supply-changes/{supplyChangeId} HTTP/1.1
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": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "e74ce006-cfd2-4e32-9dac-b27b0a4c3778",
  "bondId": "3756a24c-589e-452e-b04d-953d358d07f2",
  "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Responses

200

Successfully received a bond

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

UUIDv4 of the bond - asset id

Example: 9183411b-229c-45b7-a258-572ac8f32c01

issuerIdstring · uuidRequired

Unique UUID of the issuer in scope of this gateway

Example: dc5aaf42-d279-41d5-badf-e375803dde06

currencyIdstring · uuidRequired

Unique UUID of the currency that payouts of the bond are made with in scope of this gateway

Example: 5e63fa7d-34e9-4c3f-aa7c-cb8d9aed5cc8

brokerIdstring · uuidRequired

Unique UUID of the broker that manages this bond issue

Example: 205e9ff3-6de2-4fd6-9831-06feccb9e63c

originstring · enumRequired

Origin of the bond

Possible values:

custodianstring · nullableRequired

Custodian where asset is registered outside

Example: Custodian Bank

custodianLeiCodestring · nullableRequired

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

Example: DG3RU1DBUFHT4ZF9WN62

issuerCsdLeiCodestring · nullableRequired

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

Example: DG3RU1DBUFHT4ZF9WN62

csdRegisteredAtstring · date-time · nullableRequired

Date of registration in central depository

Example: 2034-12-30T00:00:00.000Z

underlyingInstrumentCodestring · nullableRequired

Underlying instrument code

Example: US0378331005

fisnstring · nullableRequired

Short description

Example: FUTURETECH/COMMON STOCK

countryCodestringRequired

Country code of where the security is issued

Example: LT

turnoverTypestring · enumRequired

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

Possible values:

senioritystring · enumRequired

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

Possible values:

statusstring · enumRequired

Status of the bond:

draft- bond is created
recorded- data validation was created by issuer agent and approved by operator
issued- supply change was created by issuer agent and approved by operator
distributing- bond has been recorded, issued and ongoing primary distribution (step 1/2)
live- bond is distributed (step 2/2), now live and circulating
locked- bond is locked from trading, entering maturity process (step 1/5)
mature- bond is maturing, cannot be traded or transferred (step 2/5)
collecting- bond collection in progress (step 3/5)
collected- bond collection completed (step 4/5)
closed- bond has reached the end of its lifecycle (step 5/5)

Possible values:

initialPlacementstring · enumRequired

Initial placement type

Possible values:

issuingAccountAddressstring · xrp-addressRequired

Issuing account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

operationalAccountAddressstring · xrp-addressRequired

Operational account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

isinstring · nullableRequired

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

Example: US0378331005

cfistring · nullableRequired

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

Example: DBVUGR

figistring · nullableRequired

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

Example: BBG000BLNNV0

tickerstring · nullableRequired

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

Example: AAPL

dtistring · iso-24165-dti · nullableRequired

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

nominalValueinteger · int64Required

Nominal value of a single bond unit, also known as face value, provided considering exponent of the bond currency

Example: 10

totalNominalValueinteger · int64Required

Nominal value of a full bond issue, also known as total face value, provided considering exponent of the bond currency

Example: 10000

interestRatestringRequired

Annual interest rate in % paid for holding this bond

Example: 10

interestTypestring · enumRequired

Interest type. Curently, only fixed interest rate is supported

Possible values:

interestBasestring · enumRequired

Interest calculation option

Possible values:

interestIntervalstring · enumRequired

Interest payment interval

Possible values:

settlementUnitMultiplestringRequired

Settlement unit multiple expressed in maximum decimal points amount allowed. Ex: 0,01 means 2

Example: 2

minimumSettlementUnitstringRequired

Minimum settlement unit expressed in maximum decimal points amount allowed. Ex: 0,01 means 2

Example: 2

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

securedBackingstring · nullableRequired

Backing of the secured bond

Example: Gold

issuedAtstring · date-timeRequired

Issue date of the bond.

Example: 2034-12-30T00:00:00.000Z

issuanceRecordAtstring · date-timeRequired

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

Example: 2034-12-30T00:00:00.000Z

settleAtstring · date-timeRequired

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

Example: 2034-12-30T00:00:00.000Z

maturityRecordAtstring · date-timeRequired

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

Example: 2034-12-30T00:00:00.000Z

matureAtstring · date-timeRequired

Date when the bond maturity is expected to be paid out.

Example: 2034-12-30T00:00:00.000Z

distributedAmountinteger · int64Required

Amount of bonds that have been proposed to distribute to investors

Example: 1000

requestedAmountinteger · int64Required

Amount of mature bonds requested to collect from investors

Example: 1000

collectedAmountinteger · int64Required

Amount of mature bonds collected back

Example: 1000

namestringRequired

Bond name

Example: BOND

ipfsLinkstringRequired

IPFS link

Example: /ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo

exponentnumber · max: 10Required

Exponent - number of decimal places (scale) used for this asset or currency.

Decimal floating value: stored_value / 10^exponent.
Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).
Examples: 2000 with exponent 2 => 20; 2345 with exponent 3 => 2.345; 2345 with exponent 0 => 2345.

Example: 2

supplyinteger · int64Required

Bond total supply

Example: 1000

totalSupplyinteger · int64Required

Bond total supply

Example: 1000

couponIdsstring[]Required

Coupon ids

Example: ["36dbd1cc-cc4a-43d0-a166-e3e4cd1380f7"]

maturityPaymentIdsstring[]Required

Maturity payment ids

Example: ["888431dc-1d81-4f6b-9131-475f8d3ee0f8"]

distributionIdsstring[]Required

Distribution ids

Example: ["2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"]

supplyChangeIdsstring[]Required

Supply change ids

Example: ["2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"]

dataValidationIdsstring[]Required

Sata validation ids

Example: ["2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"]

settlementTypestring · enumRequired

Corporate actions settlement type:

internal - payments (coupons, maturity) are settled within Axiology TSS using EMTs
external - payments are settled via bank or other payment systems outside Axiology TSS

Possible values:

get

/bonds/{bondId}

GET /bonds/{bondId} HTTP/1.1
Accept: */*

200

Successfully received a bond

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "9183411b-229c-45b7-a258-572ac8f32c01",
  "issuerId": "dc5aaf42-d279-41d5-badf-e375803dde06",
  "currencyId": "5e63fa7d-34e9-4c3f-aa7c-cb8d9aed5cc8",
  "brokerId": "205e9ff3-6de2-4fd6-9831-06feccb9e63c",
  "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": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "operationalAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "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,
  "requestedAmount": 1000,
  "collectedAmount": 1000,
  "name": "BOND",
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "exponent": 0,
  "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

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/accounts

GET /bonds/{bondId}/accounts HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "account": {
        "createdAt": "2026-03-22T02:47:05.633Z",
        "updatedAt": "2026-03-22T02:47:05.633Z",
        "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
        "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
        "type": "investor",
        "institutionSectorCode": "S.11",
        "walletType": "client-individual",
        "status": "active",
        "openedAt": "2026-03-22T02:47:05.633Z"
      },
      "amount": 1000
    }
  ]
}

Get bond coupons

get

Get a paginated list of bonds coupons

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/coupons

GET /bonds/{bondId}/coupons HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "fb4702b8-32d6-4e17-8d81-306dd637dcc1",
      "no": 1,
      "bondId": "052c31bc-c782-486d-ae95-438a954164e4",
      "status": "upcoming",
      "totalPayment": 1000,
      "recordAt": "2026-01-09T08:55:11.550Z",
      "payAt": "2026-02-07T08:55:11.550Z"
    }
  ]
}

get

Retrieve a list of bond coupon payments.

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

couponIdstring · uuidRequired

Coupon UUID identifier, unique in scope of this node

Example: b5abc81b-8412-4949-a352-b6c90286b09b

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/bonds/{bondId}/coupons/{couponId}/payments

GET /bonds/{bondId}/coupons/{couponId}/payments HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-03-22T02:47:05.633Z",
      "updatedAt": "2026-03-22T02:47:05.633Z",
      "id": "89ea2b89-a686-4474-87fd-8316d65edff8",
      "status": "paid",
      "receiverAddress": "r49wKDuk5e7oZNHiY5GtwBeAo7ioGoxoH",
      "bondAmount": 100000,
      "payoutAmount": 1000,
      "couponId": "464be2d3-bdf5-4075-9d92-badb6be202a1"
    }
  ]
}

Get bond distribution

get

Get bond's distribution by its id

Path parameters

bondIdstring · uuidRequired

Bond UUID identifier, globally unique to Axiology TSS

Example: f4d30128-4a8e-4a49-9272-6121c556523a

primaryDistributionIdstring · uuidRequired

Primary Distribution UUID identifier, unique in scope of this node

Example: 2c48f7f9-220b-47e1-8426-0481c9d5ddf0

Responses

200

Retrieved bond distribution

application/json

createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Primary distribution id

Example: b006212e-9da8-44a4-9be3-9e6e833e7834

brokerIdstring · uuidRequired

Broker id

Example: 0cf7f3d7-5641-4973-a85b-6c92baef0026

bondIdstring · uuidRequired

Bond id

Example: 7cba0d0f-008a-4c53-b4ac-220305e2b9d3

typestring · enumRequired

Settlement type

Possible values:

supplyinteger · int64Required

Token supply to distribute

Example: 1000

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

Date and time of primary distribution registration

statusstring · enumRequired

Status of primary distribution:

settling - distribution created and is settling
settled - distribution settled

Possible values:

get

/bonds/{bondId}/primary-distributions/{primaryDistributionId}

GET /bonds/{bondId}/primary-distributions/{primaryDistributionId} HTTP/1.1
Accept: */*

200

Retrieved bond distribution

{
  "createdAt": "2026-03-22T02:47:05.633Z",
  "updatedAt": "2026-03-22T02:47:05.633Z",
  "id": "b006212e-9da8-44a4-9be3-9e6e833e7834",
  "brokerId": "0cf7f3d7-5641-4973-a85b-6c92baef0026",
  "bondId": "7cba0d0f-008a-4c53-b4ac-220305e2b9d3",
  "type": "dvp",
  "supply": 1000,
  "reference": "Stock-split No. 12345",
  "recordedAt": "2026-03-22T02:47:05.633Z",
  "status": "settling"
}

PreviousAuctions NextOrders

Last updated 3 months ago

Good night

hashtagGet bond's auctions

hashtagCreate an auction

hashtagGet auction

hashtagCancel auction

hashtagGet all bids

hashtagCreate a bid

hashtagGet bid

hashtagFund/defund/cancel bid

hashtagPay bond coupon manually

hashtagChange bond's information

hashtagCancel bond's information

hashtagGet bond distributions

hashtagDistribute bond

hashtagRetry failed primary distribution FOP

hashtagChange bond's supply

hashtagCancel bond's supply

hashtagGet bond coupons

hashtagGet bond distribution

Get bond's auctions

Create an auction

Get auction

Cancel auction

Get all bids

Create a bid

Get bid

Fund/defund/cancel bid

Pay bond coupon manually

Change bond's information

Cancel bond's information

Get bond distributions

Distribute bond

Retry failed primary distribution FOP

Change bond's supply

Cancel bond's supply

Get bond coupons

Get bond distribution