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
200

Successfully retrieved a list of items.

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
originall ofRequired

Origin of the bond. Indicates the source of the bond

Default: native
string · enumOptional

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
turnoverTypeall ofOptional

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

Example: public
string · enumOptional

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

Possible values:
seniorityall ofRequired

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

Example: senior-debt
string · enumOptional

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

Possible values:
initialPlacementall ofRequired

Initial placement type

Example: public
string · enumOptional

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
interestTypeall ofRequired

Interest type. Currently, only fixed interest rate is supported

Example: fixed
string · enumOptional

Interest type. Curently, only fixed interest rate is supported

Possible values:
interestBaseall ofRequired

Method by which interest will be calculated

Example: act365
string · enumOptional

Interest calculation option

Possible values:
interestIntervalall ofRequired

Interest payment interval

Example: annual
string · enumOptional

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
settlementTypeall ofRequired

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: external
string · enumOptional

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
post
/bonds
201

Successfully created a bond

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
200

Successfully retrieved a list of items.

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
typeall ofRequired

Type of auction

Example: fixed-price
string · enumOptional

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
post
/bonds/{bondId}/auctions
201Success

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
get
/bonds/{bondId}/auctions/{auctionId}
200Success

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
statusall ofRequired

Update auction status

  • cancelled - cancel auction
Default: cancelled
string · enumOptional

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
patch
/bonds/{bondId}/auctions/{auctionId}
200Success

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
200

Successfully retrieved a list of items.

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
statusall ofOptional

Create bid status:

  • placed - place unfunded bid
  • funded - place funded bid
Default: placed
string · enumOptional

Create bid status:

  • placed - place unfunded bid
  • funded - place funded bid
Possible values:
Responses
post
/bonds/{bondId}/auctions/{auctionId}/bids
201

Created bid

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
get
/bonds/{bondId}/auctions/{auctionId}/bids/{bidId}
200

Auction bid

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
statusall ofRequired

Update bid status:

  • funded - fund placed bid
  • placed - defund funded bid
  • cancelled - cancel active bid
Default: funded
string · enumOptional

Create bid status:

  • placed - place unfunded bid
  • funded - place funded bid
Possible values:
Responses
200

Changed bid

application/json
patch
/bonds/{bondId}/auctions/{auctionId}/bids/{bidId}
200

Changed bid

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
patch
/bonds/{bondId}/coupons/{couponId}
200

Coupon paid

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
200

Successfully retrieved a list of items.

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
post
/bonds/{bondId}/distributions
201

Successfully created a bond distribution

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
200

Successfully retrieved a list of items.

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
get
/bonds/{bondId}/maturity-payments/{maturityPaymentId}
200

Retrieve information about single maturity payment

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
statusall ofRequired

Update maturity payment status

  • initiated - (issuer agent) re-initiate no-funds or initiation-failed
  • completed - (investor agent) accept initiated payment
Example: initiated
string · enumOptional

Status of the maturity payment

Possible values:
Responses
200

Successfully received a bond maturity payment

application/json
patch
/bonds/{bondId}/maturity-payments/{maturityPaymentId}
200

Successfully received a bond maturity payment

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}
200

Successfully retrieved a list of items.

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
200

Successfully retrieved a list of items.

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
originall ofRequired

Origin of the bond. Indicates the source of the bond

Default: native
string · enumOptional

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
turnoverTypeall ofOptional

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

Example: public
string · enumOptional

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

Possible values:
seniorityall ofRequired

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

Example: senior-debt
string · enumOptional

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

Possible values:
initialPlacementall ofRequired

Initial placement type

Example: public
string · enumOptional

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
interestTypeall ofRequired

Interest type. Currently, only fixed interest rate is supported

Example: fixed
string · enumOptional

Interest type. Curently, only fixed interest rate is supported

Possible values:
interestBaseall ofRequired

Method by which interest will be calculated

Example: act365
string · enumOptional

Interest calculation option

Possible values:
interestIntervalall ofRequired

Interest payment interval

Example: annual
string · enumOptional

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
settlementTypeall ofRequired

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: external
string · enumOptional

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
post
/bonds/{bondId}/data-validations
201

Successfully created a request to update bond data

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
statusall ofRequired

Bond data validation status

  • cancelled - cancel bond data validation
Default: cancelled
string · enumOptional

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
patch
/bonds/{bondId}/data-validations/{dataValidationId}
200

Successfully cancelled a request to update bond data

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
200

Successfully retrieved a list of bond distributions.

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
typeall ofRequired

Settlement type

Example: dvp
string · enumOptional

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
post
/bonds/{bondId}/primary-distributions
201

Successfully created distribution of a bond

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
statusall ofRequired

Update primary distribution FOP status

  • initiated - (issuer agent) initiate upcoming or initiation-failed FOP distribution
  • completed - (investor agent) complete initiated FOP distribution
Example: initiated
string · enumOptional

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
patch
/bonds/{bondId}/primary-distributions/{primaryDistributionId}/fops/{fopId}
200

Successfully retried primary distribution FOP.

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
200

Successfully retrieved a list of items.

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
actionall ofRequired

Action that is wished to be performed with the bond supply

Example: additionalTokenisation
string · enumOptional

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
post
/bonds/{bondId}/supply-changes
201

Successfully created a request to update bond supply

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
statusall ofRequired

Update bond supply change status:

  • cancelled - cancel bond supply change
Example: cancelled
string · enumOptional

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
patch
/bonds/{bondId}/supply-changes/{supplyChangeId}
200

Successfully cancelled a request to update bond supply

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
get
/bonds/{bondId}
200

Successfully received a bond

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
200

Successfully retrieved a list of items.

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
200

Successfully retrieved a list of items.

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
200

Successfully retrieved a list of items.

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
get
/bonds/{bondId}/primary-distributions/{primaryDistributionId}
200

Retrieved bond distribution

PreviousAuctionsNextOrders

Last updated