> For the complete documentation index, see [llms.txt](https://axiology.gitbook.io/axiology-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://axiology.gitbook.io/axiology-docs/rest-api/models.md).

# Models

## The PaginationRequestDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}}}}}
```

## The PaginationResponseDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PaginationResponseDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1},"totalItems":{"type":"number","description":"Total items count"},"totalPages":{"type":"number","description":"Total pages count"}},"required":["totalItems","totalPages"]}}}}
```

## The SubscriptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SubscriptionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund subscription UUID identifier, global in scope of TSS","format":"uuid"},"fundId":{"type":"string","description":"Fund (asset) id the subscription is for","format":"uuid"},"investorBrokerId":{"type":"string","description":"Broker id of the investor's agent","format":"uuid"},"issuerBrokerId":{"type":"string","description":"Broker id of the fund issuer","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Lifecycle status of the subscription","allOf":[{"$ref":"#/components/schemas/SubscriptionStatus"}]},"totalPrice":{"nullable":true,"description":"Requested or settled price, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"nullable":true,"description":"Requested or settled amount, in fund units\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestReference":{"type":"string","description":"Reference provided when the subscription was requested","maxLength":256,"nullable":true},"resolutionReference":{"type":"string","description":"Reference provided when the subscription was settled, rejected or cancelled","maxLength":256,"nullable":true}},"required":["createdAt","updatedAt","id","fundId","investorBrokerId","issuerBrokerId","accountAddress","cashLegType","status","totalPrice","amount","requestReference","resolutionReference"]},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"SubscriptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund subscription status:**\n- `requested` - subscription requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; units delivered to the investor"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterSubscriptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterSubscriptionDto":{"type":"object","properties":{"fundId":{"description":"Filter subscriptions by fund (asset) id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"accountAddress":{"description":"Filter subscriptions by investor wallet address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"investorBrokerId":{"description":"Filter subscriptions by investor's broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuerBrokerId":{"description":"Filter subscriptions by issuer broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"cashLegType":{"description":"Filter subscriptions by cash leg settlement method","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SettlementMethod"},"minItems":1},{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Filter subscriptions by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionStatus"},"minItems":1},{"$ref":"#/components/schemas/SubscriptionStatus"}]}}},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"SubscriptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund subscription status:**\n- `requested` - subscription requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; units delivered to the investor"}}}}
```

## The FilterMode object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterMode":{"type":"string","enum":["and","or"]}}}}
```

## The DepositStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DepositStatus":{"type":"string","enum":["approved","deposited","initiated","rejected"],"description":"Status of deposit"}}}}
```

## The DepositDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DepositDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Deposit UUID identifier, global in scope of TSS","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID identifier","format":"uuid"},"currencyId":{"type":"string","description":"Currency UUID identifier","format":"uuid"},"accountAddress":{"type":"string","description":"Destination account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"iban":{"type":"string","description":"Source IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"amount":{"format":"int64","description":"Deposit amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status of deposit","allOf":[{"$ref":"#/components/schemas/DepositStatus"}]},"transactionId":{"type":"string","description":"SEPA payment's Transaction Id","format":"iso-20022-payment-tx-id","minLength":10,"maxLength":35},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["createdAt","updatedAt","id","brokerId","currencyId","accountAddress","iban","amount","status","transactionId","correlationId"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"DepositStatus":{"type":"string","enum":["approved","deposited","initiated","rejected"],"description":"Status of deposit"}}}}
```

## The WithdrawalStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"WithdrawalStatus":{"type":"string","enum":["failed","initiated","rejected","returned","started","withdrawn"],"description":"Status of withdrawal"}}}}
```

## The WithdrawalDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"WithdrawalDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Withdrawal UUID identifier, global in scope of TSS","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID identifier","format":"uuid"},"currencyId":{"type":"string","description":"Currency UUID identifier","format":"uuid"},"accountAddress":{"type":"string","description":"Source account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"iban":{"type":"string","description":"Destination IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"amount":{"format":"int64","description":"Withdrawal amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status of withdrawal","allOf":[{"$ref":"#/components/schemas/WithdrawalStatus"}]},"transactionId":{"type":"string","description":"SEPA payment's Transaction Id","format":"iso-20022-payment-tx-id","minLength":10,"maxLength":35,"nullable":true},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["createdAt","updatedAt","id","brokerId","currencyId","accountAddress","iban","amount","status","transactionId","correlationId"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"WithdrawalStatus":{"type":"string","enum":["failed","initiated","rejected","returned","started","withdrawn"],"description":"Status of withdrawal"}}}}
```

## The InstitutionSectorCode object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The WalletType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"}}}}
```

## The CreateAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateAccountDto":{"type":"object","properties":{"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","allOf":[{"$ref":"#/components/schemas/WalletType"}]}},"required":["institutionSectorCode","walletType"]},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"}}}}
```

## The AccountType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"}}}}
```

## The AccountStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"}}}}
```

## The AccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of account","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","type":"string","description":"Opened date"}},"required":["createdAt","updatedAt","nodeId","address","type","institutionSectorCode","walletType","status","openedAt"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"}}}}
```

## The UpdateAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateAccountDto":{"type":"object","properties":{"status":{"description":"**Freeze/unfreeze account:**\n- `frozen` - freeze account\n- `active` - unfreeze account","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]}}},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"}}}}
```

## The MaturityPaymentStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MaturityPaymentStatus":{"type":"string","enum":["recorded","no-funds","initiated","initiation-failed","completed","completion-failed"],"description":"Status of the maturity payment"}}}}
```

## The MaturityPaymentDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MaturityPaymentDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Maturity Payment UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the maturity payment","allOf":[{"$ref":"#/components/schemas/MaturityPaymentStatus"}]},"bondId":{"type":"string","description":"Unique UUID of the bond in scope of this gateway","format":"uuid"},"bondAmount":{"format":"int64","description":"Bond amount for this maturity payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"payoutAmount":{"format":"int64","description":"Amount to pay for this maturity payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"receiverAddress":{"type":"string","description":"Payment`s receiver address corresponding to the investor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"errorMessage":{"type":"string","description":"Error message"}},"required":["createdAt","updatedAt","id","status","bondId","bondAmount","payoutAmount","receiverAddress"]},"MaturityPaymentStatus":{"type":"string","enum":["recorded","no-funds","initiated","initiation-failed","completed","completion-failed"],"description":"Status of the maturity payment"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CouponPaymentStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CouponPaymentStatus":{"type":"string","enum":["paid","unpaid"],"description":"Status of the coupon payment"}}}}
```

## The CouponPaymentDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CouponPaymentDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Coupon payment UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the coupon payment","allOf":[{"$ref":"#/components/schemas/CouponPaymentStatus"}]},"receiverAddress":{"type":"string","description":"Payment`s receiver address corresponding to the investor account address"},"bondAmount":{"format":"int64","description":"Bond amount for this coupon payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"payoutAmount":{"format":"int64","description":"Amount to pay for this payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"couponId":{"type":"string","description":"Id of the coupon this payment is created from","format":"uuid"}},"required":["createdAt","updatedAt","id","status","receiverAddress","bondAmount","payoutAmount","couponId"]},"CouponPaymentStatus":{"type":"string","enum":["paid","unpaid"],"description":"Status of the coupon payment"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterAccountDto":{"type":"object","properties":{"address":{"description":"Filter accounts by address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"nodeId":{"description":"Filter accounts by node ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"type":{"description":"Filter accounts by type","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/AccountType"},"minItems":1},{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"Filter accounts by institution sector code","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/InstitutionSectorCode"},"minItems":1},{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Filter accounts by wallet type","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/WalletType"},"minItems":1},{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"Filter accounts by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/AccountStatus"},"minItems":1},{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","description":"Filter accounts by opened date range","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"}}}}
```

## The BasicAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BasicAccountDto":{"type":"object","properties":{"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]}},"required":["nodeId","address","institutionSectorCode","walletType"]},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"}}}}
```

## The OtcTradeDvpStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OtcTradeDvpStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"}}}}
```

## The OtcTradeDvpDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OtcTradeDvpDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"OTC DVP Trade UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the trade","allOf":[{"$ref":"#/components/schemas/OtcTradeDvpStatus"}]},"initiatorAccountAddress":{"type":"string","description":"Initiator account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"initiatorSendAssetId":{"type":"string","description":"Initiator asset id","format":"uuid"},"initiatorSendAmount":{"format":"int64","description":"Initiator amount to send.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"initiatorBrokerId":{"type":"string","description":"Initiator broker id","format":"uuid"},"acceptorAccountAddress":{"type":"string","description":"Acceptor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"acceptorSendAssetId":{"type":"string","description":"Acceptor asset id","format":"uuid"},"acceptorSendAmount":{"format":"int64","description":"Acceptor amount to send.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"acceptorBrokerId":{"type":"string","description":"Acceptor broker id","format":"uuid"},"tradedAt":{"format":"date-time","type":"string","description":"Trade date"}},"required":["createdAt","updatedAt","id","status","initiatorAccountAddress","initiatorSendAssetId","initiatorSendAmount","initiatorBrokerId","acceptorAccountAddress","acceptorSendAssetId","acceptorSendAmount","acceptorBrokerId","tradedAt"]},"OtcTradeDvpStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The OtcTradeFopStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OtcTradeFopStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"}}}}
```

## The OtcReason object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OtcReason":{"type":"string","enum":["internal","external","restriction","error","client-instruction"],"description":"Reason for the trade"}}}}
```

## The OtcTradeFopDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OtcTradeFopDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"OTC FOP Trade UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the trade","allOf":[{"$ref":"#/components/schemas/OtcTradeFopStatus"}]},"assetId":{"type":"string","description":"Initiator asset id","format":"uuid"},"amount":{"format":"int64","description":"Initiator amount to send.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"initiatorAccountAddress":{"type":"string","description":"Initiator account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"initiatorBrokerId":{"type":"string","description":"Initiator broker id","format":"uuid"},"acceptorAccountAddress":{"type":"string","description":"Acceptor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"acceptorBrokerId":{"type":"string","description":"Acceptor broker id","format":"uuid"},"reason":{"description":"Reason for the trade","nullable":true,"allOf":[{"$ref":"#/components/schemas/OtcReason"}]},"tradedAt":{"format":"date-time","type":"string","description":"Trade date"}},"required":["createdAt","updatedAt","id","status","assetId","amount","initiatorAccountAddress","initiatorBrokerId","acceptorAccountAddress","acceptorBrokerId","reason","tradedAt"]},"OtcTradeFopStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"OtcReason":{"type":"string","enum":["internal","external","restriction","error","client-instruction"],"description":"Reason for the trade"}}}}
```

## The BondOrigin object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"}}}}
```

## The TurnoverType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"}}}}
```

## The BondSeniority object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"}}}}
```

## The BondStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BondStatus":{"type":"string","enum":["draft","recorded","issued","distributing","live","locked","mature","collecting","collected","closed"],"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)"}}}}
```

## The InitialPlacementType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"}}}}
```

## The PAC2 object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."}}}}
```

## The BoLSecurityTypeCode object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."}}}}
```

## The InterestType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"}}}}
```

## The InterestBaseOptions object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"}}}}
```

## The InterestIntervalOptions object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"}}}}
```

## The SettlementType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"}}}}
```

## The BondDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BondDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bond UUID identifier, global in scope of TSS","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the currency that payouts of the bond are made with in scope of this gateway","format":"uuid"},"brokerId":{"type":"string","description":"Unique UUID of the broker that manages this bond issue","format":"uuid"},"origin":{"description":"Origin of the bond","allOf":[{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Custodian where asset is registered outside","nullable":true},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","nullable":true},"issuerCsdLeiCode":{"type":"string","description":"LEI code of central securities depository where the issuer has registered the securities","nullable":true},"csdRegisteredAt":{"type":"string","description":"Date of registration in central depository","format":"date-time","nullable":true},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code","nullable":true},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35,"nullable":true},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"turnoverType":{"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred","nullable":true,"allOf":[{"$ref":"#/components/schemas/TurnoverType"}]},"seniority":{"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation","allOf":[{"$ref":"#/components/schemas/BondSeniority"}]},"status":{"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)","allOf":[{"$ref":"#/components/schemas/BondStatus"}]},"initialPlacement":{"description":"Initial placement type","default":"public","allOf":[{"$ref":"#/components/schemas/InitialPlacementType"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isin":{"type":"string","description":" International Securities Identification Number. Code that uniquely identifies a security globally","nullable":true},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$","nullable":true},"figi":{"type":"string","description":"Financial Instrument Global Identifier. Code that uniquely identifies a security globally","nullable":true},"ticker":{"type":"string","description":"Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes","nullable":true},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"issuePrice":{"type":"string","description":"Price of the bond issue"},"nominalValue":{"format":"int64","description":"Nominal value of a single bond unit, also known as face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalNominalValue":{"format":"int64","description":"Nominal value of a full bond issue, also known as total face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"type":"string","description":"Annual interest rate in % paid for holding this bond"},"interestType":{"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference","allOf":[{"$ref":"#/components/schemas/InterestType"}]},"interestBase":{"description":"Interest calculation option","allOf":[{"$ref":"#/components/schemas/InterestBaseOptions"}]},"interestInterval":{"description":"Interest payment interval","allOf":[{"$ref":"#/components/schemas/InterestIntervalOptions"}]},"settlementUnitMultiple":{"type":"string","description":"Settlement unit multiple expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"minimumSettlementUnit":{"type":"string","description":"Minimum settlement unit expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the bond prospectus registered"},"preEmptiveRights":{"type":"boolean","description":"Indicator, if the bond has pre-emptive rights"},"earlyRedemption":{"type":"boolean","description":"Indicator, if the bond can be redeemed early"},"secured":{"type":"boolean","description":"Indicator, if the bond is secured"},"securedBacking":{"type":"string","description":"Backing of the secured bond","nullable":true},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the bond."},"issuanceRecordAt":{"format":"date-time","type":"string","description":"Bond issue record date, from which the coupon accumulation starts."},"settleAt":{"format":"date-time","type":"string","description":"Date when the bond was or is expected to be fully distributed among initial holders."},"maturityRecordAt":{"format":"date-time","type":"string","description":"Date when the bond reaches maturity and final owners are fixed."},"matureAt":{"format":"date-time","type":"string","description":"Date when the bond maturity is expected to be paid out."},"distributedAmount":{"format":"int64","description":"Amount of bonds that have been proposed to distribute to investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestedAmount":{"format":"int64","description":"Amount of mature bonds requested to collect from investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"collectedAmount":{"format":"int64","description":"Amount of mature bonds collected back.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"name":{"type":"string","description":"Bond name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current bond supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total bond supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"couponIds":{"description":"Coupon ids","type":"array","items":{"type":"string"}},"maturityPaymentIds":{"description":"Maturity payment ids","type":"array","items":{"type":"string"}},"distributionIds":{"description":"Distribution ids","type":"array","items":{"type":"string"}},"settlementType":{"description":"**Corporate actions settlement type:**\n- `internal` - payments (coupons, maturity) are settled within Axiology TSS using EMTs\n- `external` - payments are settled via bank or other payment systems outside Axiology TSS","allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"displayNotation":{"description":"Display hint only. The bond's monetary fields are returned as scaled monetary amounts regardless of this value; consumers use it to decide whether to render values as a percentage of nominal or as a per-unit amount.","allOf":[{"$ref":"#/components/schemas/PriceNotation"}]}},"required":["createdAt","updatedAt","id","issuerId","currencyId","brokerId","origin","custodian","custodianLeiCode","issuerCsdLeiCode","csdRegisteredAt","underlyingInstrumentCode","fisn","countryCode","turnoverType","seniority","status","initialPlacement","issuingAccountAddress","operationalAccountAddress","isin","cfi","figi","ticker","dti","ecbClassification","bolClassification","issuePrice","nominalValue","totalNominalValue","interestRate","interestType","interestBase","interestInterval","settlementUnitMultiple","minimumSettlementUnit","prospectusRegistered","preEmptiveRights","earlyRedemption","secured","securedBacking","issuedAt","issuanceRecordAt","settleAt","maturityRecordAt","matureAt","distributedAmount","requestedAmount","collectedAmount","name","specUrl","exponent","supply","totalSupply","couponIds","maturityPaymentIds","distributionIds","settlementType","displayNotation"]},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"BondStatus":{"type":"string","enum":["draft","recorded","issued","distributing","live","locked","mature","collecting","collected","closed"],"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"},"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"},"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."}}}}
```

## The AccountBondBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountBondBalanceDto":{"type":"object","properties":{"bond":{"description":"Bond details","allOf":[{"$ref":"#/components/schemas/BondDto"}]},"amount":{"format":"int64","description":"Bond amount held in the account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reservedAmount":{"format":"int64","description":"Bond amount reserved by open orders or pending settlement.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["bond","amount","reservedAmount"]},"BondDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bond UUID identifier, global in scope of TSS","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the currency that payouts of the bond are made with in scope of this gateway","format":"uuid"},"brokerId":{"type":"string","description":"Unique UUID of the broker that manages this bond issue","format":"uuid"},"origin":{"description":"Origin of the bond","allOf":[{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Custodian where asset is registered outside","nullable":true},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","nullable":true},"issuerCsdLeiCode":{"type":"string","description":"LEI code of central securities depository where the issuer has registered the securities","nullable":true},"csdRegisteredAt":{"type":"string","description":"Date of registration in central depository","format":"date-time","nullable":true},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code","nullable":true},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35,"nullable":true},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"turnoverType":{"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred","nullable":true,"allOf":[{"$ref":"#/components/schemas/TurnoverType"}]},"seniority":{"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation","allOf":[{"$ref":"#/components/schemas/BondSeniority"}]},"status":{"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)","allOf":[{"$ref":"#/components/schemas/BondStatus"}]},"initialPlacement":{"description":"Initial placement type","default":"public","allOf":[{"$ref":"#/components/schemas/InitialPlacementType"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isin":{"type":"string","description":" International Securities Identification Number. Code that uniquely identifies a security globally","nullable":true},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$","nullable":true},"figi":{"type":"string","description":"Financial Instrument Global Identifier. Code that uniquely identifies a security globally","nullable":true},"ticker":{"type":"string","description":"Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes","nullable":true},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"issuePrice":{"type":"string","description":"Price of the bond issue"},"nominalValue":{"format":"int64","description":"Nominal value of a single bond unit, also known as face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalNominalValue":{"format":"int64","description":"Nominal value of a full bond issue, also known as total face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"type":"string","description":"Annual interest rate in % paid for holding this bond"},"interestType":{"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference","allOf":[{"$ref":"#/components/schemas/InterestType"}]},"interestBase":{"description":"Interest calculation option","allOf":[{"$ref":"#/components/schemas/InterestBaseOptions"}]},"interestInterval":{"description":"Interest payment interval","allOf":[{"$ref":"#/components/schemas/InterestIntervalOptions"}]},"settlementUnitMultiple":{"type":"string","description":"Settlement unit multiple expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"minimumSettlementUnit":{"type":"string","description":"Minimum settlement unit expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the bond prospectus registered"},"preEmptiveRights":{"type":"boolean","description":"Indicator, if the bond has pre-emptive rights"},"earlyRedemption":{"type":"boolean","description":"Indicator, if the bond can be redeemed early"},"secured":{"type":"boolean","description":"Indicator, if the bond is secured"},"securedBacking":{"type":"string","description":"Backing of the secured bond","nullable":true},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the bond."},"issuanceRecordAt":{"format":"date-time","type":"string","description":"Bond issue record date, from which the coupon accumulation starts."},"settleAt":{"format":"date-time","type":"string","description":"Date when the bond was or is expected to be fully distributed among initial holders."},"maturityRecordAt":{"format":"date-time","type":"string","description":"Date when the bond reaches maturity and final owners are fixed."},"matureAt":{"format":"date-time","type":"string","description":"Date when the bond maturity is expected to be paid out."},"distributedAmount":{"format":"int64","description":"Amount of bonds that have been proposed to distribute to investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestedAmount":{"format":"int64","description":"Amount of mature bonds requested to collect from investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"collectedAmount":{"format":"int64","description":"Amount of mature bonds collected back.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"name":{"type":"string","description":"Bond name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current bond supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total bond supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"couponIds":{"description":"Coupon ids","type":"array","items":{"type":"string"}},"maturityPaymentIds":{"description":"Maturity payment ids","type":"array","items":{"type":"string"}},"distributionIds":{"description":"Distribution ids","type":"array","items":{"type":"string"}},"settlementType":{"description":"**Corporate actions settlement type:**\n- `internal` - payments (coupons, maturity) are settled within Axiology TSS using EMTs\n- `external` - payments are settled via bank or other payment systems outside Axiology TSS","allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"displayNotation":{"description":"Display hint only. The bond's monetary fields are returned as scaled monetary amounts regardless of this value; consumers use it to decide whether to render values as a percentage of nominal or as a per-unit amount.","allOf":[{"$ref":"#/components/schemas/PriceNotation"}]}},"required":["createdAt","updatedAt","id","issuerId","currencyId","brokerId","origin","custodian","custodianLeiCode","issuerCsdLeiCode","csdRegisteredAt","underlyingInstrumentCode","fisn","countryCode","turnoverType","seniority","status","initialPlacement","issuingAccountAddress","operationalAccountAddress","isin","cfi","figi","ticker","dti","ecbClassification","bolClassification","issuePrice","nominalValue","totalNominalValue","interestRate","interestType","interestBase","interestInterval","settlementUnitMultiple","minimumSettlementUnit","prospectusRegistered","preEmptiveRights","earlyRedemption","secured","securedBacking","issuedAt","issuanceRecordAt","settleAt","maturityRecordAt","matureAt","distributedAmount","requestedAmount","collectedAmount","name","specUrl","exponent","supply","totalSupply","couponIds","maturityPaymentIds","distributionIds","settlementType","displayNotation"]},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"BondStatus":{"type":"string","enum":["draft","recorded","issued","distributing","live","locked","mature","collecting","collected","closed"],"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"},"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"},"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."}}}}
```

## The QueryAccountBondDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryAccountBondDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get account bonds by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The CurrencyDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CurrencyDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Currency UUID identifier, global in scope of TSS","format":"uuid"},"name":{"type":"string","description":"Full name of the currency"},"code":{"type":"string","description":"Unique code of the currency"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supplyLimit":{"format":"int64","description":"Maximum amount of currency allowed in circulation.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"}},"required":["createdAt","updatedAt","id","name","code","exponent","supplyLimit","issuingAccountAddress","operationalAccountAddress"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The AccountCurrencyBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountCurrencyBalanceDto":{"type":"object","properties":{"currency":{"description":"Currency of the balance","allOf":[{"$ref":"#/components/schemas/CurrencyDto"}]},"amount":{"format":"int64","description":"Amount of this currency held in the account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reservedAmount":{"format":"int64","description":"Amount of this currency reserved by open orders or pending settlement.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["currency","amount","reservedAmount"]},"CurrencyDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Currency UUID identifier, global in scope of TSS","format":"uuid"},"name":{"type":"string","description":"Full name of the currency"},"code":{"type":"string","description":"Unique code of the currency"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supplyLimit":{"format":"int64","description":"Maximum amount of currency allowed in circulation.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"}},"required":["createdAt","updatedAt","id","name","code","exponent","supplyLimit","issuingAccountAddress","operationalAccountAddress"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The QueryAccountCurrencyDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryAccountCurrencyDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get account currencies by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The EquityStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityStatus":{"type":"string","enum":["recorded","live","suspended","closed"],"description":"Status of equity"}}}}
```

## The EquityDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Equity UUID identifier, global in scope of TSS","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the currency equity in scope of this gateway","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of issuer in scope of this gateway","format":"uuid"},"nominalValue":{"format":"int64","description":"Price of ONE share.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issueDate":{"type":"string","description":"Issue registration date"},"status":{"description":"Status of equity","allOf":[{"$ref":"#/components/schemas/EquityStatus"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address"},"operationalAccountAddress":{"type":"string","description":"Operational account address"},"name":{"type":"string","description":"A user friendly name of the asset (ex. Orange Bond)"},"supply":{"format":"int64","description":"Total supply of the asset that exists amongst all platforms together.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"specUrl":{"type":"string","description":"IPFS link"},"isin":{"type":"string","description":"An International Securities Identification Number","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"undistributedAmount":{"format":"int64","description":"Undistributed amount of the equity placed in warm wallet\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["createdAt","updatedAt","id","currencyId","issuerId","nominalValue","issueDate","status","issuingAccountAddress","operationalAccountAddress","name","supply","specUrl","isin","ecbClassification","undistributedAmount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"EquityStatus":{"type":"string","enum":["recorded","live","suspended","closed"],"description":"Status of equity"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."}}}}
```

## The AccountEquityBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountEquityBalanceDto":{"type":"object","properties":{"equity":{"description":"Equity details","allOf":[{"$ref":"#/components/schemas/EquityDto"}]},"amount":{"format":"int64","description":"Equity amount held in the account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reservedAmount":{"format":"int64","description":"Equity amount reserved by open orders or pending settlement.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["equity","amount","reservedAmount"]},"EquityDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Equity UUID identifier, global in scope of TSS","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the currency equity in scope of this gateway","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of issuer in scope of this gateway","format":"uuid"},"nominalValue":{"format":"int64","description":"Price of ONE share.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issueDate":{"type":"string","description":"Issue registration date"},"status":{"description":"Status of equity","allOf":[{"$ref":"#/components/schemas/EquityStatus"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address"},"operationalAccountAddress":{"type":"string","description":"Operational account address"},"name":{"type":"string","description":"A user friendly name of the asset (ex. Orange Bond)"},"supply":{"format":"int64","description":"Total supply of the asset that exists amongst all platforms together.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"specUrl":{"type":"string","description":"IPFS link"},"isin":{"type":"string","description":"An International Securities Identification Number","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"undistributedAmount":{"format":"int64","description":"Undistributed amount of the equity placed in warm wallet\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["createdAt","updatedAt","id","currencyId","issuerId","nominalValue","issueDate","status","issuingAccountAddress","operationalAccountAddress","name","supply","specUrl","isin","ecbClassification","undistributedAmount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"EquityStatus":{"type":"string","enum":["recorded","live","suspended","closed"],"description":"Status of equity"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."}}}}
```

## The QueryAccountEquityDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryAccountEquityDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get account equities by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The FundStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FundStatus":{"type":"string","enum":["draft","live","locked","collecting","collected","closed"],"description":"Lifecycle status of the fund"}}}}
```

## The FundDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FundDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund UUID identifier, global in scope of TSS","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the settlement currency in scope of this gateway","format":"uuid"},"brokerId":{"type":"string","description":"Unique UUID of the broker that manages this fund","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/InstrumentOrigin"}]},"vehicleType":{"allOf":[{"$ref":"#/components/schemas/VehicleType"}]},"incomeUse":{"allOf":[{"$ref":"#/components/schemas/IncomeUse"}]},"managementCompanyLei":{"type":"string","description":"LEI of the fund management company","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"mmfFlag":{"type":"boolean","description":"Flag indicating this fund is a Money Market Fund unit"},"mmfVariant":{"allOf":[{"$ref":"#/components/schemas/MmfVariant"}],"nullable":true},"custodian":{"type":"string","description":"Custodian where asset is registered outside","nullable":true},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"issuerCsdLeiCode":{"type":"string","description":"LEI code of central securities depository where the issuer has registered the securities","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code","nullable":true},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35,"nullable":true},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"status":{"description":"Lifecycle status of the fund","allOf":[{"$ref":"#/components/schemas/FundStatus"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isin":{"type":"string","description":"International Securities Identification Number","nullable":true},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$","nullable":true},"figi":{"type":"string","description":"Financial Instrument Global Identifier","nullable":true},"ticker":{"type":"string","description":"Stock ticker symbol","nullable":true},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"settlementUnitMultiple":{"type":"string","description":"Settlement unit multiple expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"minimumSettlementUnit":{"type":"string","description":"Minimum settlement unit expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the fund prospectus registered"},"isSubscribable":{"type":"boolean","description":"Whether the fund currently accepts subscriptions"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the fund."},"name":{"type":"string","description":"Fund name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current fund supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settlementType":{"allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"distributedAmount":{"format":"int64","description":"Amount of fund units that have been proposed to distribute to investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"cutOffTime":{"type":"string","description":"Cut-off time — deadline to receive subscriptions","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"freezeMinutesBeforeCutOff":{"type":"number","description":"Freeze window before the cut-off, in minutes"},"shareClassName":{"type":"string","description":"Share class of the fund","nullable":true},"managementFee":{"nullable":true,"description":"Annual management fee, expressed as a percentage (0–100).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"minimumInvestment":{"type":"string","description":"Minimum investment required to subscribe to the fund","nullable":true},"payoutType":{"allOf":[{"$ref":"#/components/schemas/PayoutType"}],"nullable":true}},"required":["createdAt","updatedAt","id","issuerId","currencyId","brokerId","origin","vehicleType","incomeUse","managementCompanyLei","mmfFlag","mmfVariant","custodian","custodianLeiCode","issuerCsdLeiCode","underlyingInstrumentCode","fisn","countryCode","status","issuingAccountAddress","operationalAccountAddress","isin","cfi","figi","ticker","dti","ecbClassification","bolClassification","settlementUnitMultiple","minimumSettlementUnit","prospectusRegistered","isSubscribable","issuedAt","name","specUrl","exponent","supply","settlementType","distributedAmount","cutOffTime","freezeMinutesBeforeCutOff","shareClassName","managementFee","minimumInvestment","payoutType"]},"InstrumentOrigin":{"type":"string","enum":["native","tokenized"],"description":"**Origin of the fund:**\n- `native` - fund originally issued on Axiology TSS\n- `tokenized` - immobilised external fund tokenised on Axiology TSS"},"VehicleType":{"type":"string","enum":["UCITS sub-fund","AIF","Securitisation compartment","Standalone fund"],"description":"**Vehicle type of the fund:**\n- `UCITS sub-fund` - sub-fund of a UCITS umbrella\n- `AIF` - alternative investment fund\n- `Securitisation compartment` - compartment of a securitisation vehicle\n- `Standalone fund` - standalone fund without an umbrella structure"},"IncomeUse":{"type":"string","enum":["accumulating","distributing"],"description":"**Income use policy of the fund:**\n- `accumulating` - income is reinvested into the fund's NAV\n- `distributing` - income is paid out to unit-holders"},"MmfVariant":{"type":"string","enum":["CNAV","LVNAV","VNAV","Short-Term VNAV"],"description":"**Money Market Fund variant:**\n- `CNAV` - Constant Net Asset Value\n- `LVNAV` - Low-Volatility Net Asset Value\n- `VNAV` - Variable Net Asset Value\n- `Short-Term VNAV` - Short-Term Variable Net Asset Value"},"FundStatus":{"type":"string","enum":["draft","live","locked","collecting","collected","closed"],"description":"Lifecycle status of the fund"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"PayoutType":{"type":"string","enum":["currency","units"],"description":"**How the fund pays out income:**\n- `currency` - paid out in the settlement currency\n- `units` - reinvested as fund units"}}}}
```

## The AccountFundBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountFundBalanceDto":{"type":"object","properties":{"fund":{"description":"Fund details","allOf":[{"$ref":"#/components/schemas/FundDto"}]},"amount":{"format":"int64","description":"Fund amount held in the account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reservedAmount":{"format":"int64","description":"Fund amount reserved by open orders or pending settlement.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["fund","amount","reservedAmount"]},"FundDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund UUID identifier, global in scope of TSS","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the settlement currency in scope of this gateway","format":"uuid"},"brokerId":{"type":"string","description":"Unique UUID of the broker that manages this fund","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/InstrumentOrigin"}]},"vehicleType":{"allOf":[{"$ref":"#/components/schemas/VehicleType"}]},"incomeUse":{"allOf":[{"$ref":"#/components/schemas/IncomeUse"}]},"managementCompanyLei":{"type":"string","description":"LEI of the fund management company","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"mmfFlag":{"type":"boolean","description":"Flag indicating this fund is a Money Market Fund unit"},"mmfVariant":{"allOf":[{"$ref":"#/components/schemas/MmfVariant"}],"nullable":true},"custodian":{"type":"string","description":"Custodian where asset is registered outside","nullable":true},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"issuerCsdLeiCode":{"type":"string","description":"LEI code of central securities depository where the issuer has registered the securities","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code","nullable":true},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35,"nullable":true},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"status":{"description":"Lifecycle status of the fund","allOf":[{"$ref":"#/components/schemas/FundStatus"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isin":{"type":"string","description":"International Securities Identification Number","nullable":true},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$","nullable":true},"figi":{"type":"string","description":"Financial Instrument Global Identifier","nullable":true},"ticker":{"type":"string","description":"Stock ticker symbol","nullable":true},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"settlementUnitMultiple":{"type":"string","description":"Settlement unit multiple expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"minimumSettlementUnit":{"type":"string","description":"Minimum settlement unit expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the fund prospectus registered"},"isSubscribable":{"type":"boolean","description":"Whether the fund currently accepts subscriptions"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the fund."},"name":{"type":"string","description":"Fund name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current fund supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settlementType":{"allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"distributedAmount":{"format":"int64","description":"Amount of fund units that have been proposed to distribute to investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"cutOffTime":{"type":"string","description":"Cut-off time — deadline to receive subscriptions","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"freezeMinutesBeforeCutOff":{"type":"number","description":"Freeze window before the cut-off, in minutes"},"shareClassName":{"type":"string","description":"Share class of the fund","nullable":true},"managementFee":{"nullable":true,"description":"Annual management fee, expressed as a percentage (0–100).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"minimumInvestment":{"type":"string","description":"Minimum investment required to subscribe to the fund","nullable":true},"payoutType":{"allOf":[{"$ref":"#/components/schemas/PayoutType"}],"nullable":true}},"required":["createdAt","updatedAt","id","issuerId","currencyId","brokerId","origin","vehicleType","incomeUse","managementCompanyLei","mmfFlag","mmfVariant","custodian","custodianLeiCode","issuerCsdLeiCode","underlyingInstrumentCode","fisn","countryCode","status","issuingAccountAddress","operationalAccountAddress","isin","cfi","figi","ticker","dti","ecbClassification","bolClassification","settlementUnitMultiple","minimumSettlementUnit","prospectusRegistered","isSubscribable","issuedAt","name","specUrl","exponent","supply","settlementType","distributedAmount","cutOffTime","freezeMinutesBeforeCutOff","shareClassName","managementFee","minimumInvestment","payoutType"]},"InstrumentOrigin":{"type":"string","enum":["native","tokenized"],"description":"**Origin of the fund:**\n- `native` - fund originally issued on Axiology TSS\n- `tokenized` - immobilised external fund tokenised on Axiology TSS"},"VehicleType":{"type":"string","enum":["UCITS sub-fund","AIF","Securitisation compartment","Standalone fund"],"description":"**Vehicle type of the fund:**\n- `UCITS sub-fund` - sub-fund of a UCITS umbrella\n- `AIF` - alternative investment fund\n- `Securitisation compartment` - compartment of a securitisation vehicle\n- `Standalone fund` - standalone fund without an umbrella structure"},"IncomeUse":{"type":"string","enum":["accumulating","distributing"],"description":"**Income use policy of the fund:**\n- `accumulating` - income is reinvested into the fund's NAV\n- `distributing` - income is paid out to unit-holders"},"MmfVariant":{"type":"string","enum":["CNAV","LVNAV","VNAV","Short-Term VNAV"],"description":"**Money Market Fund variant:**\n- `CNAV` - Constant Net Asset Value\n- `LVNAV` - Low-Volatility Net Asset Value\n- `VNAV` - Variable Net Asset Value\n- `Short-Term VNAV` - Short-Term Variable Net Asset Value"},"FundStatus":{"type":"string","enum":["draft","live","locked","collecting","collected","closed"],"description":"Lifecycle status of the fund"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"PayoutType":{"type":"string","enum":["currency","units"],"description":"**How the fund pays out income:**\n- `currency` - paid out in the settlement currency\n- `units` - reinvested as fund units"}}}}
```

## The QueryAccountFundDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryAccountFundDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get account funds by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The RedemptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"RedemptionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund redemption UUID identifier, global in scope of TSS","format":"uuid"},"fundId":{"type":"string","description":"Fund (asset) id the redemption is for","format":"uuid"},"investorBrokerId":{"type":"string","description":"Broker id of the investor's agent","format":"uuid"},"issuerBrokerId":{"type":"string","description":"Broker id of the fund issuer","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Lifecycle status of the redemption","allOf":[{"$ref":"#/components/schemas/RedemptionStatus"}]},"totalPrice":{"nullable":true,"description":"Settled cash proceeds, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"format":"int64","description":"Amount of fund units to redeem\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestReference":{"type":"string","description":"Reference provided when the redemption was requested","maxLength":256,"nullable":true},"resolutionReference":{"type":"string","description":"Reference provided when the redemption was settled, rejected or cancelled","maxLength":256,"nullable":true}},"required":["createdAt","updatedAt","id","fundId","investorBrokerId","issuerBrokerId","accountAddress","cashLegType","status","totalPrice","amount","requestReference","resolutionReference"]},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"RedemptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund redemption status:**\n- `requested` - redemption requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; cash delivered to the investor"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The AssetType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AssetType":{"type":"string","enum":["currency","bond","equity","fund"],"description":"Type of the asset"}}}}
```

## The AssetDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AssetDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Asset UUID identifier, global in scope of TSS","format":"uuid"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this asset","format":"uuid"},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of the asset","allOf":[{"$ref":"#/components/schemas/AssetType"}]},"name":{"type":"string","description":"Asset name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current asset supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total asset supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"isTradeable":{"type":"boolean","description":"Indicates if the asset can be traded"}},"required":["createdAt","updatedAt","id","nodeId","issuingAccountAddress","operationalAccountAddress","type","name","specUrl","exponent","supply","totalSupply","ecbClassification","bolClassification","isTradeable"]},"AssetType":{"type":"string","enum":["currency","bond","equity","fund"],"description":"Type of the asset"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."}}}}
```

## The FilterAssetDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterAssetDto":{"type":"object","properties":{"id":{"description":"Filter by asset ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"nodeId":{"description":"Filter by node ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuingAccountAddress":{"description":"Filter by issuing account's address(es)","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"operationalAccountAddress":{"description":"Filter by operational account's address(es)","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"name":{"description":"Filter by asset name(s)","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string","description":"Partial asset name"}]},"type":{"description":"Filter by assets type(s)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/AssetType"},"minItems":1},{"$ref":"#/components/schemas/AssetType"}]},"createdAt":{"format":"date-time","description":"Filter assets created from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"AssetType":{"type":"string","enum":["currency","bond","equity","fund"],"description":"Type of the asset"}}}}
```

## The AuctionType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AuctionType":{"type":"string","enum":["fixed-price","min-price"],"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive"}}}}
```

## The AuctionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AuctionStatus":{"type":"string","enum":["upcoming","open","closed","settled","failed","cancelled"],"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent"}}}}
```

## The AuctionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AuctionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Auction UUID identifier, unique in scope of this node","format":"uuid"},"brokerId":{"type":"string","description":"Broker id","format":"uuid"},"assetId":{"type":"string","description":"Asset id","format":"uuid"},"type":{"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive","allOf":[{"$ref":"#/components/schemas/AuctionType"}]},"status":{"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent","allOf":[{"$ref":"#/components/schemas/AuctionStatus"}]},"minAmount":{"format":"int64","description":"Minimal amount that needs to be auctioned off for the auction to succeed.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"price":{"format":"int64","description":"Minimal or fixed price, determined by auction type.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"startAt":{"format":"date-time","type":"string","description":"Date and time of auction opening"},"endAt":{"format":"date-time","type":"string","description":"Date and time of auction closing"},"settledAmount":{"nullable":true,"description":"Total settled amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledTotalPrice":{"nullable":true,"description":"Settled total price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledAt":{"format":"date-time","type":"string","description":"Date and time of auction settlement","nullable":true}},"required":["createdAt","updatedAt","id","brokerId","assetId","type","status","minAmount","price","startAt","endAt","settledAmount","settledTotalPrice","settledAt"]},"AuctionType":{"type":"string","enum":["fixed-price","min-price"],"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive"},"AuctionStatus":{"type":"string","enum":["upcoming","open","closed","settled","failed","cancelled"],"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterAuctionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterAuctionDto":{"type":"object","properties":{"id":{"description":"Filter by single or multiple auction ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"type":{"description":"Filter by type of auction","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/AuctionType"},"minItems":1},{"$ref":"#/components/schemas/AuctionType"}]},"status":{"description":"Filter by status of auction","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/AuctionStatus"},"minItems":1},{"$ref":"#/components/schemas/AuctionStatus"}]},"startAt":{"format":"date-time","description":"Filter by auction start date and time","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"endAt":{"format":"date-time","description":"Filter by auction end date and time","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"brokerId":{"description":"Filter by single or multiple broker ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"bondId":{"description":"Filter by single or multiple bond ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]}}},"AuctionType":{"type":"string","enum":["fixed-price","min-price"],"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive"},"AuctionStatus":{"type":"string","enum":["upcoming","open","closed","settled","failed","cancelled"],"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent"}}}}
```

## The CreateCouponDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateCouponDto":{"type":"object","properties":{"no":{"type":"number","description":"Coupon №"},"totalPayment":{"format":"int64","description":"Total payment of coupon, in the bond currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"nullable":true,"description":"Annual interest rate applicable to this coupon period. Maximum 100%. May be omitted for periods whose rate is not yet determined (e.g. floating-rate bonds).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"recordAt":{"format":"date-time","type":"string","description":"The official coupon record date and time. Timestamp marking the official coupon record cutoff (typically end of day, e.g. 23:59:59), defining which bondholders are legally entitled to receive the upcoming coupon payment according bond terms/prospectus."},"payAt":{"format":"date-time","type":"string","description":"Date of coupon's payment, must be later than record date."}},"required":["no","totalPayment","recordAt","payAt"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The CreateBondDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateBondDto":{"type":"object","properties":{"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway to assign as this bond's issuer","format":"uuid"},"currencyId":{"type":"string","description":"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","format":"uuid"},"name":{"type":"string","description":"Full name of the bond"},"origin":{"description":"Origin of the bond. Indicates the source of the bond","default":"native","allOf":[{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Custodian where asset is registered outside"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities"},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer in central securities depository"},"csdRegisteredAt":{"format":"date-time","type":"string","description":"Date of registration in central depository"},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code"},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"turnoverType":{"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred","allOf":[{"$ref":"#/components/schemas/TurnoverType"}]},"seniority":{"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation","allOf":[{"$ref":"#/components/schemas/BondSeniority"}]},"initialPlacement":{"description":"Initial placement type","allOf":[{"$ref":"#/components/schemas/InitialPlacementType"}]},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"isin":{"type":"string","description":"International Securities Identification Number. Code that uniquely identifies a security globally"},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$"},"figi":{"type":"string","description":"Financial Instrument Global Identifier. Code that uniquely identifies a security globally"},"ticker":{"type":"string","description":"Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes"},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$"},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"issuePrice":{"type":"string","description":"Price of the bond issue"},"totalSupply":{"format":"int64","description":"Total amount of bond units that exist or will exist.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"nominalValue":{"format":"int64","description":"Nominal/face value of one bond, in the chosen currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"type":"string","description":"Annual interest rate in % paid for holding this bond"},"interestType":{"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference","allOf":[{"$ref":"#/components/schemas/InterestType"}]},"interestBase":{"description":"Method by which interest will be calculated","allOf":[{"$ref":"#/components/schemas/InterestBaseOptions"}]},"interestInterval":{"description":"Interest payment interval","allOf":[{"$ref":"#/components/schemas/InterestIntervalOptions"}]},"minimumSettlementUnit":{"type":"string","description":"Up to what part a bond can be divided"},"settlementUnitMultiple":{"type":"string","description":"The smallest part of settlement currency to trade"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the bond prospectus registered"},"preEmptiveRights":{"type":"boolean","description":"Indicator, if the bond has pre-emptive rights"},"earlyRedemption":{"type":"boolean","description":"Indicator, if the bond can be redeemed early"},"secured":{"type":"boolean","description":"Indicator, if the bond is secured"},"securedBacking":{"type":"string","description":"Backing of the secured bond"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the bond."},"issuanceRecordAt":{"format":"date-time","type":"string","description":"Bond issue record date, from which the coupon accumulation starts."},"settleAt":{"format":"date-time","type":"string","description":"Date when the bond was or is expected to be fully distributed among initial holders."},"maturityRecordAt":{"format":"date-time","type":"string","description":"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."},"matureAt":{"format":"date-time","type":"string","description":"Date of bond's maturity or simpler, end of bond's lifetime."},"coupons":{"description":"Coupons defining periodic interest payments for this bond.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CreateCouponDto"}},"reference":{"type":"string","description":"Reference to the new bond data document or other relevant information."},"settlementType":{"description":"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)","allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"displayNotation":{"description":"Display hint only. The bond's monetary fields are returned as scaled monetary amounts regardless of this value; consumers use it to decide whether to render values as a percentage of nominal or as a per-unit amount.","allOf":[{"$ref":"#/components/schemas/PriceNotation"}]}},"required":["issuerId","currencyId","name","origin","countryCode","seniority","initialPlacement","exponent","ecbClassification","bolClassification","issuePrice","totalSupply","nominalValue","interestRate","interestType","interestBase","interestInterval","minimumSettlementUnit","settlementUnitMultiple","prospectusRegistered","preEmptiveRights","earlyRedemption","secured","issuedAt","issuanceRecordAt","settleAt","maturityRecordAt","matureAt","reference","settlementType","displayNotation"]},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"},"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"},"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"},"CreateCouponDto":{"type":"object","properties":{"no":{"type":"number","description":"Coupon №"},"totalPayment":{"format":"int64","description":"Total payment of coupon, in the bond currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"nullable":true,"description":"Annual interest rate applicable to this coupon period. Maximum 100%. May be omitted for periods whose rate is not yet determined (e.g. floating-rate bonds).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"recordAt":{"format":"date-time","type":"string","description":"The official coupon record date and time. Timestamp marking the official coupon record cutoff (typically end of day, e.g. 23:59:59), defining which bondholders are legally entitled to receive the upcoming coupon payment according bond terms/prospectus."},"payAt":{"format":"date-time","type":"string","description":"Date of coupon's payment, must be later than record date."}},"required":["no","totalPayment","recordAt","payAt"]},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."}}}}
```

## The CreateAuctionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateAuctionDto":{"type":"object","properties":{"type":{"description":"Type of auction","allOf":[{"$ref":"#/components/schemas/AuctionType"}]},"price":{"format":"int64","description":"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'.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"minAmount":{"format":"int64","description":"Minimal amount of bond units that must be auctioned off for the auction to be considered successful.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"startAt":{"format":"date-time","type":"string","description":"Date and time when auction opens"},"endAt":{"format":"date-time","type":"string","description":"Date and time when auction closes"}},"required":["type","price","minAmount","startAt","endAt"]},"AuctionType":{"type":"string","enum":["fixed-price","min-price"],"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The UpdateAuctionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateAuctionDto":{"type":"object","properties":{"status":{"description":"**Update auction status**\n- `cancelled` - cancel auction","default":"cancelled","allOf":[{"$ref":"#/components/schemas/AuctionStatus"}]}},"required":["status"]},"AuctionStatus":{"type":"string","enum":["upcoming","open","closed","settled","failed","cancelled"],"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent"}}}}
```

## The BidStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BidStatus":{"type":"string","enum":["placed","funded","matched","settled","not-matched","rejected","cancelled"],"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid"}}}}
```

## The CreateBidDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateBidDto":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Account address that is placing a bid","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"price":{"format":"int64","description":"Bid price per bond unit.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"format":"int64","description":"Amount of bond units the bid is for.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid","default":"placed","allOf":[{"$ref":"#/components/schemas/BidStatus"}]}},"required":["accountAddress","price","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"BidStatus":{"type":"string","enum":["placed","funded","matched","settled","not-matched","rejected","cancelled"],"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid"}}}}
```

## The BidDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BidDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bid UUID identifier, unique in scope of this node","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID that placed the bid","format":"uuid"},"assetId":{"type":"string","description":"Asset UUID that the bid is for","format":"uuid"},"auctionId":{"type":"string","description":"Auction UUID that the bid is for","format":"uuid"},"accountAddress":{"type":"string","description":"Account address that placed the bid","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"status":{"description":"Auction bid status","allOf":[{"$ref":"#/components/schemas/BidStatus"}]},"amount":{"format":"int64","description":"Bond amount the bid is for.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"price":{"format":"int64","description":"Bond price per unit.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalPrice":{"format":"int64","description":"Total bid price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"placedAt":{"format":"date-time","type":"string","description":"Bid placement time","nullable":true},"settledAmount":{"nullable":true,"description":"Settled amount the bid is for.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledTotalPrice":{"nullable":true,"description":"Settled total price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledAt":{"format":"date-time","type":"string","description":"Bid settlement time","nullable":true}},"required":["createdAt","updatedAt","id","brokerId","assetId","auctionId","accountAddress","status","amount","price","totalPrice","placedAt","settledAmount","settledTotalPrice","settledAt"]},"BidStatus":{"type":"string","enum":["placed","funded","matched","settled","not-matched","rejected","cancelled"],"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The UpdateBidDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateBidDto":{"type":"object","properties":{"status":{"description":"**Update bid status:**\n- `funded` - fund `placed` bid\n- `placed` - defund `funded` bid\n- `cancelled` - cancel active bid","default":"funded","allOf":[{"$ref":"#/components/schemas/BidStatus"}]}},"required":["status"]},"BidStatus":{"type":"string","enum":["placed","funded","matched","settled","not-matched","rejected","cancelled"],"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid"}}}}
```

## The CouponStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CouponStatus":{"type":"string","enum":["paid","readyToPay","upcoming","paying","noFunds"],"description":"Coupon status"}}}}
```

## The CouponDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CouponDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Coupon UUID identifier, global in scope of TSS","format":"uuid"},"no":{"type":"number","description":"Coupon №"},"bondId":{"type":"string","description":"Bond UUID, unique in scope of this node","format":"uuid"},"status":{"description":"Coupon status","allOf":[{"$ref":"#/components/schemas/CouponStatus"}]},"totalPayment":{"format":"int64","description":"Total payment of coupon, in the bond currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"nullable":true,"description":"Annual interest rate applicable to this coupon period. Null when not yet set.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"recordAt":{"format":"date-time","type":"string","description":"Date of coupon's period end, bond holders are recorded."},"payAt":{"format":"date-time","type":"string","description":"Date of coupon's payment, must be later than record date."}},"required":["createdAt","updatedAt","id","no","bondId","status","totalPayment","interestRate","recordAt","payAt"]},"CouponStatus":{"type":"string","enum":["paid","readyToPay","upcoming","paying","noFunds"],"description":"Coupon status"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The FilterMaturityPaymentDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterMaturityPaymentDto":{"type":"object","properties":{"status":{"description":"Filter maturity payments by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/MaturityPaymentStatus"},"minItems":1},{"$ref":"#/components/schemas/MaturityPaymentStatus"}]},"receiverAddress":{"type":"string","description":"Filter maturity payments by receiver account address"}}},"MaturityPaymentStatus":{"type":"string","enum":["recorded","no-funds","initiated","initiation-failed","completed","completion-failed"],"description":"Status of the maturity payment"}}}}
```

## The UpdateMaturityPaymentDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateMaturityPaymentDto":{"type":"object","properties":{"status":{"description":"**Update maturity payment status**\n- `initiated` - (issuer agent) re-initiate `no-funds` or `initiation-failed`\n- `completed` - (investor agent) accept `initiated` payment","allOf":[{"$ref":"#/components/schemas/MaturityPaymentStatus"}]}},"required":["status"]},"MaturityPaymentStatus":{"type":"string","enum":["recorded","no-funds","initiated","initiation-failed","completed","completion-failed"],"description":"Status of the maturity payment"}}}}
```

## The LegacyOrderType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"LegacyOrderType":{"type":"string","enum":["buy","sell"],"description":"Order Type"}}}}
```

## The CreateOrderDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateOrderDto":{"type":"object","properties":{"currencyId":{"type":"string","description":"Unique UUID of the currency in scope of this gateway","format":"uuid"},"price":{"type":"number","description":"Total price of the currency"},"bondId":{"type":"string","description":"Unique UUID of the bond in scope of this gateway","format":"uuid"},"amount":{"type":"number","description":"Total amount of the bond"},"type":{"description":"Order Type","allOf":[{"$ref":"#/components/schemas/LegacyOrderType"}]},"expiration":{"format":"date-time","type":"string","description":"Expiration date"},"accountAddress":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"}},"required":["currencyId","price","bondId","amount","type","accountAddress"]},"LegacyOrderType":{"type":"string","enum":["buy","sell"],"description":"Order Type"}}}}
```

## The LegacyOrderStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"LegacyOrderStatus":{"type":"string","enum":["active","consumed","cancelled","expired"],"description":"Status of the order"}}}}
```

## The LegacyOrderDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"LegacyOrderDto":{"type":"object","properties":{"created_at":{"format":"date-time","type":"string","description":"Created date"},"updated_at":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Order UUID identifier, unique in scope of this node","format":"uuid"},"account_address":{"type":"string","description":"Address of the account that places the order","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"buy_token_id":{"type":"string","description":"Unique identifier for the token being bought in the order in scope of this gateway","format":"uuid"},"buy_amount":{"type":"number","description":"Total amount of the token being bought"},"buy_remaining_amount":{"type":"number","description":"Remaining amount of the token being bought"},"sell_token_id":{"type":"string","description":"Unique identifier for the token being sold in the order in scope of this gateway","format":"uuid"},"sell_amount":{"type":"number","description":"Total amount of the token being sold"},"sell_remaining_amount":{"type":"number","description":"Remaining amount of the token being sold"},"type":{"description":"Type of the order","allOf":[{"$ref":"#/components/schemas/LegacyOrderType"}]},"status":{"description":"Status of the order","allOf":[{"$ref":"#/components/schemas/LegacyOrderStatus"}]},"ratio":{"type":"number","description":"Ratio of the order"},"expires_at":{"format":"date-time","type":"string","description":"Expiration date of the order.","nullable":true}},"required":["created_at","updated_at","id","account_address","buy_token_id","buy_amount","buy_remaining_amount","sell_token_id","sell_amount","sell_remaining_amount","type","status","ratio"]},"LegacyOrderType":{"type":"string","enum":["buy","sell"],"description":"Order Type"},"LegacyOrderStatus":{"type":"string","enum":["active","consumed","cancelled","expired"],"description":"Status of the order"}}}}
```

## The UpdateOrderLegacyDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateOrderLegacyDto":{"type":"object","properties":{"currencyId":{"type":"string","description":"Unique UUID of the currency in scope of this gateway","format":"uuid"},"price":{"type":"number","description":"Total price of the currency"},"bondId":{"type":"string","description":"Unique UUID of the bond in scope of this gateway","format":"uuid"},"amount":{"type":"number","description":"Total amount of the bond"},"type":{"description":"Order Type","allOf":[{"$ref":"#/components/schemas/LegacyOrderType"}]},"expiration":{"format":"date-time","type":"string","description":"Expiration date"}},"required":["currencyId","price","bondId","amount","type"]},"LegacyOrderType":{"type":"string","enum":["buy","sell"],"description":"Order Type"}}}}
```

## The PriceCandleDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PriceCandleDto":{"type":"object","properties":{"created_at":{"format":"date-time","type":"string","description":"Created date"},"updated_at":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Price candlestick UUID identifier, unique in scope of this node","format":"uuid"},"tokenPairId":{"type":"string","description":"Identifier for the related token pair","format":"uuid"},"open":{"type":"number","description":"Opening price of the candlestick"},"close":{"type":"number","description":"Closing price of the candlestick"},"low":{"type":"number","description":"Lowest price during the candlestick period"},"high":{"type":"number","description":"Highest price during the candlestick period"},"length":{"type":"number","description":"Length of the candlestick in minutes"},"candleBegin":{"format":"date-time","type":"string","description":"Start daytime of the candlestick range"},"candleEnd":{"format":"date-time","type":"string","description":"End daytime of the candlestick range"}},"required":["created_at","updated_at","id","tokenPairId","open","close","low","high","length","candleBegin","candleEnd"]}}}}
```

## The CreateBondDataValidationSpecDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateBondDataValidationSpecDto":{"type":"object","properties":{"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway to assign as this bond's issuer","format":"uuid"},"currencyId":{"type":"string","description":"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","format":"uuid"},"name":{"type":"string","description":"Full name of the bond"},"origin":{"description":"Origin of the bond. Indicates the source of the bond","default":"native","allOf":[{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Custodian where asset is registered outside"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities"},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer in central securities depository"},"csdRegisteredAt":{"format":"date-time","type":"string","description":"Date of registration in central depository"},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code"},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"turnoverType":{"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred","allOf":[{"$ref":"#/components/schemas/TurnoverType"}]},"seniority":{"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation","allOf":[{"$ref":"#/components/schemas/BondSeniority"}]},"initialPlacement":{"description":"Initial placement type","allOf":[{"$ref":"#/components/schemas/InitialPlacementType"}]},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"isin":{"type":"string","description":"International Securities Identification Number. Code that uniquely identifies a security globally"},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$"},"figi":{"type":"string","description":"Financial Instrument Global Identifier. Code that uniquely identifies a security globally"},"ticker":{"type":"string","description":"Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes"},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$"},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"issuePrice":{"type":"string","description":"Price of the bond issue"},"totalSupply":{"format":"int64","description":"Total amount of bond units that exist or will exist.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"nominalValue":{"format":"int64","description":"Nominal/face value of one bond, in the chosen currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"type":"string","description":"Annual interest rate in % paid for holding this bond"},"interestType":{"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference","allOf":[{"$ref":"#/components/schemas/InterestType"}]},"interestBase":{"description":"Method by which interest will be calculated","allOf":[{"$ref":"#/components/schemas/InterestBaseOptions"}]},"interestInterval":{"description":"Interest payment interval","allOf":[{"$ref":"#/components/schemas/InterestIntervalOptions"}]},"minimumSettlementUnit":{"type":"string","description":"Up to what part a bond can be divided"},"settlementUnitMultiple":{"type":"string","description":"The smallest part of settlement currency to trade"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the bond prospectus registered"},"preEmptiveRights":{"type":"boolean","description":"Indicator, if the bond has pre-emptive rights"},"earlyRedemption":{"type":"boolean","description":"Indicator, if the bond can be redeemed early"},"secured":{"type":"boolean","description":"Indicator, if the bond is secured"},"securedBacking":{"type":"string","description":"Backing of the secured bond"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the bond."},"issuanceRecordAt":{"format":"date-time","type":"string","description":"Bond issue record date, from which the coupon accumulation starts."},"settleAt":{"format":"date-time","type":"string","description":"Date when the bond was or is expected to be fully distributed among initial holders."},"maturityRecordAt":{"format":"date-time","type":"string","description":"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."},"matureAt":{"format":"date-time","type":"string","description":"Date of bond's maturity or simpler, end of bond's lifetime."},"coupons":{"description":"Coupons defining periodic interest payments for this bond.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CreateCouponDto"}},"settlementType":{"description":"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)","allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"displayNotation":{"description":"Display hint only. The bond's monetary fields are returned as scaled monetary amounts regardless of this value; consumers use it to decide whether to render values as a percentage of nominal or as a per-unit amount.","allOf":[{"$ref":"#/components/schemas/PriceNotation"}]}},"required":["issuerId","currencyId","name","origin","countryCode","seniority","initialPlacement","exponent","ecbClassification","bolClassification","issuePrice","totalSupply","nominalValue","interestRate","interestType","interestBase","interestInterval","minimumSettlementUnit","settlementUnitMultiple","prospectusRegistered","preEmptiveRights","earlyRedemption","secured","issuedAt","issuanceRecordAt","settleAt","maturityRecordAt","matureAt","settlementType","displayNotation"]},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"},"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"},"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"},"CreateCouponDto":{"type":"object","properties":{"no":{"type":"number","description":"Coupon №"},"totalPayment":{"format":"int64","description":"Total payment of coupon, in the bond currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"nullable":true,"description":"Annual interest rate applicable to this coupon period. Maximum 100%. May be omitted for periods whose rate is not yet determined (e.g. floating-rate bonds).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"recordAt":{"format":"date-time","type":"string","description":"The official coupon record date and time. Timestamp marking the official coupon record cutoff (typically end of day, e.g. 23:59:59), defining which bondholders are legally entitled to receive the upcoming coupon payment according bond terms/prospectus."},"payAt":{"format":"date-time","type":"string","description":"Date of coupon's payment, must be later than record date."}},"required":["no","totalPayment","recordAt","payAt"]},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."}}}}
```

## The CreateBondDataValidationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateBondDataValidationDto":{"type":"object","properties":{"initiationReference":{"type":"string","description":"Arbitrary reference provided by the broker to the bond data validation initiation"},"spec":{"description":"Proposed bond data to validate","allOf":[{"$ref":"#/components/schemas/CreateBondDataValidationSpecDto"}]}},"required":["initiationReference","spec"]},"CreateBondDataValidationSpecDto":{"type":"object","properties":{"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway to assign as this bond's issuer","format":"uuid"},"currencyId":{"type":"string","description":"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","format":"uuid"},"name":{"type":"string","description":"Full name of the bond"},"origin":{"description":"Origin of the bond. Indicates the source of the bond","default":"native","allOf":[{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Custodian where asset is registered outside"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities"},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer in central securities depository"},"csdRegisteredAt":{"format":"date-time","type":"string","description":"Date of registration in central depository"},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code"},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"turnoverType":{"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred","allOf":[{"$ref":"#/components/schemas/TurnoverType"}]},"seniority":{"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation","allOf":[{"$ref":"#/components/schemas/BondSeniority"}]},"initialPlacement":{"description":"Initial placement type","allOf":[{"$ref":"#/components/schemas/InitialPlacementType"}]},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"isin":{"type":"string","description":"International Securities Identification Number. Code that uniquely identifies a security globally"},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$"},"figi":{"type":"string","description":"Financial Instrument Global Identifier. Code that uniquely identifies a security globally"},"ticker":{"type":"string","description":"Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes"},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$"},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"issuePrice":{"type":"string","description":"Price of the bond issue"},"totalSupply":{"format":"int64","description":"Total amount of bond units that exist or will exist.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"nominalValue":{"format":"int64","description":"Nominal/face value of one bond, in the chosen currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"type":"string","description":"Annual interest rate in % paid for holding this bond"},"interestType":{"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference","allOf":[{"$ref":"#/components/schemas/InterestType"}]},"interestBase":{"description":"Method by which interest will be calculated","allOf":[{"$ref":"#/components/schemas/InterestBaseOptions"}]},"interestInterval":{"description":"Interest payment interval","allOf":[{"$ref":"#/components/schemas/InterestIntervalOptions"}]},"minimumSettlementUnit":{"type":"string","description":"Up to what part a bond can be divided"},"settlementUnitMultiple":{"type":"string","description":"The smallest part of settlement currency to trade"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the bond prospectus registered"},"preEmptiveRights":{"type":"boolean","description":"Indicator, if the bond has pre-emptive rights"},"earlyRedemption":{"type":"boolean","description":"Indicator, if the bond can be redeemed early"},"secured":{"type":"boolean","description":"Indicator, if the bond is secured"},"securedBacking":{"type":"string","description":"Backing of the secured bond"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the bond."},"issuanceRecordAt":{"format":"date-time","type":"string","description":"Bond issue record date, from which the coupon accumulation starts."},"settleAt":{"format":"date-time","type":"string","description":"Date when the bond was or is expected to be fully distributed among initial holders."},"maturityRecordAt":{"format":"date-time","type":"string","description":"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."},"matureAt":{"format":"date-time","type":"string","description":"Date of bond's maturity or simpler, end of bond's lifetime."},"coupons":{"description":"Coupons defining periodic interest payments for this bond.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CreateCouponDto"}},"settlementType":{"description":"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)","allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"displayNotation":{"description":"Display hint only. The bond's monetary fields are returned as scaled monetary amounts regardless of this value; consumers use it to decide whether to render values as a percentage of nominal or as a per-unit amount.","allOf":[{"$ref":"#/components/schemas/PriceNotation"}]}},"required":["issuerId","currencyId","name","origin","countryCode","seniority","initialPlacement","exponent","ecbClassification","bolClassification","issuePrice","totalSupply","nominalValue","interestRate","interestType","interestBase","interestInterval","minimumSettlementUnit","settlementUnitMultiple","prospectusRegistered","preEmptiveRights","earlyRedemption","secured","issuedAt","issuanceRecordAt","settleAt","maturityRecordAt","matureAt","settlementType","displayNotation"]},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"},"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"},"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"},"CreateCouponDto":{"type":"object","properties":{"no":{"type":"number","description":"Coupon №"},"totalPayment":{"format":"int64","description":"Total payment of coupon, in the bond currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"nullable":true,"description":"Annual interest rate applicable to this coupon period. Maximum 100%. May be omitted for periods whose rate is not yet determined (e.g. floating-rate bonds).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"recordAt":{"format":"date-time","type":"string","description":"The official coupon record date and time. Timestamp marking the official coupon record cutoff (typically end of day, e.g. 23:59:59), defining which bondholders are legally entitled to receive the upcoming coupon payment according bond terms/prospectus."},"payAt":{"format":"date-time","type":"string","description":"Date of coupon's payment, must be later than record date."}},"required":["no","totalPayment","recordAt","payAt"]},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."}}}}
```

## The DataValidationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DataValidationDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Data validation UUID identifier, global in scope of TSS","format":"uuid"},"assetId":{"type":"string","description":"Unique UUID of the asset in scope of this gateway","format":"uuid"},"status":{"allOf":[{"$ref":"#/components/schemas/DataValidationStatus"}]},"specUrl":{"type":"string","description":"IPFS link with data that was validated or needs to be validated"},"initiationReference":{"type":"string","description":"Reference provided by the broker during data validation initiation"},"validationReference":{"type":"string","description":"Reference provided by the operator during data validation","nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Date when the data validation was initiated"},"validatedAt":{"type":"string","description":"Date when the data validation was completed","format":"date-time","nullable":true}},"required":["createdAt","updatedAt","id","assetId","status","specUrl","initiationReference","validationReference","initiatedAt","validatedAt"]},"DataValidationStatus":{"type":"string","enum":["approved","cancelled","initiated","rejected"],"description":"**Data validation status:**\n- `initiated` - data validation has been requested and is awaiting operator review\n- `approved` - operator approved the data validation\n- `rejected` - operator rejected the data validation\n- `cancelled` - data validation was cancelled by the broker"}}}}
```

## The DataValidationStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DataValidationStatus":{"type":"string","enum":["approved","cancelled","initiated","rejected"],"description":"**Data validation status:**\n- `initiated` - data validation has been requested and is awaiting operator review\n- `approved` - operator approved the data validation\n- `rejected` - operator rejected the data validation\n- `cancelled` - data validation was cancelled by the broker"}}}}
```

## The UpdateBondDataValidationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateBondDataValidationDto":{"type":"object","properties":{"status":{"description":"**Bond data validation status**\n- `cancelled` - cancel bond data validation","default":"cancelled","allOf":[{"$ref":"#/components/schemas/DataValidationStatus"}]},"reference":{"type":"string","description":"Arbitrary reference provided by the broker to the bond data validation"}},"required":["status","reference"]},"DataValidationStatus":{"type":"string","enum":["approved","cancelled","initiated","rejected"],"description":"**Data validation status:**\n- `initiated` - data validation has been requested and is awaiting operator review\n- `approved` - operator approved the data validation\n- `rejected` - operator rejected the data validation\n- `cancelled` - data validation was cancelled by the broker"}}}}
```

## The FopDistributee object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FopDistributee":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Address of the account to distribute the asset to. Can be both one of this broker's investors or another broker's","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of asset units to send to the provided receiver.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["accountAddress","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The DvpDistributee object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DvpDistributee":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Address of the account to distribute the asset to. Can be both one of this broker's investors or another broker's","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of asset units to send to the provided receiver.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"currencyAmount":{"format":"int64","description":"Price per asset unit to pay for in DVP type.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["accountAddress","amount","currencyAmount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CreateDistributionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateDistributionDto":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/DistributionType"}]},"reference":{"type":"string","description":"Reference to a document or corporate action number, etc. - anything that could help relate distribution actions with other context"},"recordedAt":{"format":"date-time","type":"string","description":"Day when the action was documented to be executed. This is not necessarily the day when the asset is actually distributed to the investor."},"distributees":{"type":"array","description":"Array of accounts to distribute the asset to","items":{"oneOf":[{"$ref":"#/components/schemas/FopDistributee"},{"$ref":"#/components/schemas/DvpDistributee"}]}}},"required":["type","reference","recordedAt","distributees"]},"DistributionType":{"type":"string","enum":["fop","dvp"],"description":"**Type of distribution:**\n- `fop` - Free Of Payment: asset units are transferred for free\n- `dvp` - Delivery Versus Payment: asset units are transferred for an agreed currency amount"},"FopDistributee":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Address of the account to distribute the asset to. Can be both one of this broker's investors or another broker's","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of asset units to send to the provided receiver.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["accountAddress","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"DvpDistributee":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Address of the account to distribute the asset to. Can be both one of this broker's investors or another broker's","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of asset units to send to the provided receiver.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"currencyAmount":{"format":"int64","description":"Price per asset unit to pay for in DVP type.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["accountAddress","amount","currencyAmount"]}}}}
```

## The DistributionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DistributionStatus":{"type":"string","enum":["settling","settled"],"description":"**Status of distribution:**\n- `settling` - distribution created and is settling\n- `settled` - distribution settled"}}}}
```

## The DistributionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DistributionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Distribution UUID identifier, global in scope of TSS","format":"uuid"},"brokerId":{"type":"string","description":"Broker id","format":"uuid"},"assetId":{"type":"string","description":"Asset id","format":"uuid"},"type":{"allOf":[{"$ref":"#/components/schemas/DistributionType"}]},"supply":{"format":"int64","description":"Token supply to distribute.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Reference to a document or corporate action number, etc. - anything that could help relate distribution actions with other context"},"recordedAt":{"format":"date-time","type":"string","description":"Date and time of distribution registration"},"status":{"description":"**Status of distribution:**\n- `settling` - distribution created and is settling\n- `settled` - distribution settled","allOf":[{"$ref":"#/components/schemas/DistributionStatus"}]}},"required":["createdAt","updatedAt","id","brokerId","assetId","type","supply","reference","recordedAt","status"]},"DistributionType":{"type":"string","enum":["fop","dvp"],"description":"**Type of distribution:**\n- `fop` - Free Of Payment: asset units are transferred for free\n- `dvp` - Delivery Versus Payment: asset units are transferred for an agreed currency amount"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"DistributionStatus":{"type":"string","enum":["settling","settled"],"description":"**Status of distribution:**\n- `settling` - distribution created and is settling\n- `settled` - distribution settled"}}}}
```

## The DistributionFopStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DistributionFopStatus":{"type":"string","enum":["upcoming","initiated","initiation-failed","completed","completion-failed"],"description":"**Update distribution FOP status**\n- `initiated` - (issuer agent) initiate `upcoming` or `initiation-failed` FOP distribution\n- `completed` - (investor agent) complete `initiated` FOP distribution"}}}}
```

## The UpdateDistributionFopDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateDistributionFopDto":{"type":"object","properties":{"status":{"description":"**Update distribution FOP status**\n- `initiated` - (issuer agent) initiate `upcoming` or `initiation-failed` FOP distribution\n- `completed` - (investor agent) complete `initiated` FOP distribution","allOf":[{"$ref":"#/components/schemas/DistributionFopStatus"}]}},"required":["status"]},"DistributionFopStatus":{"type":"string","enum":["upcoming","initiated","initiation-failed","completed","completion-failed"],"description":"**Update distribution FOP status**\n- `initiated` - (issuer agent) initiate `upcoming` or `initiation-failed` FOP distribution\n- `completed` - (investor agent) complete `initiated` FOP distribution"}}}}
```

## The DistributionFopDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DistributionFopDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Distribution FOP UUID identifier, unique in scope of this node","format":"uuid"},"distributionId":{"type":"string","description":"Distribution id","format":"uuid"},"assetId":{"type":"string","description":"Asset id","format":"uuid"},"accountAddress":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount to receive.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status","allOf":[{"$ref":"#/components/schemas/DistributionFopStatus"}]},"settledAt":{"format":"date-time","type":"string","description":"Date and time of distribution FOP"}},"required":["createdAt","updatedAt","id","distributionId","assetId","accountAddress","amount","status","settledAt"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"DistributionFopStatus":{"type":"string","enum":["upcoming","initiated","initiation-failed","completed","completion-failed"],"description":"**Update distribution FOP status**\n- `initiated` - (issuer agent) initiate `upcoming` or `initiation-failed` FOP distribution\n- `completed` - (investor agent) complete `initiated` FOP distribution"}}}}
```

## The SupplyChangeAction object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SupplyChangeAction":{"type":"string","enum":["additionalTokenisation","initialTokenisation","issuance","redemption","supplyDecrease","supplyIncrease"],"description":"Action of supply change request"}}}}
```

## The CreateBondSupplyChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateBondSupplyChangeDto":{"type":"object","properties":{"amount":{"format":"int64","description":"Signed change in bond supply. Positive increases supply, negative decreases it.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"action":{"description":"Action that is wished to be performed with the bond supply","allOf":[{"$ref":"#/components/schemas/SupplyChangeAction"}]},"initiationReference":{"type":"string","description":"Arbitrary reference provided by the broker to the bond supply change initiation"}},"required":["amount","action","initiationReference"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"SupplyChangeAction":{"type":"string","enum":["additionalTokenisation","initialTokenisation","issuance","redemption","supplyDecrease","supplyIncrease"],"description":"Action of supply change request"}}}}
```

## The SupplyChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SupplyChangeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Supply Change UUID identifier, global in scope of TSS","format":"uuid"},"assetId":{"type":"string","description":"Unique UUID of the asset in scope of this gateway","format":"uuid"},"status":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeStatus"}]},"amount":{"format":"int64","description":"Amount change in supply requested (positive for issuance, negative for burn).\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"action":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeAction"}]},"initiationReference":{"type":"string","description":"Reference provided by the broker during supply change initiation"},"validationReference":{"type":"string","description":"Reference provided by the operator during supply change validation","nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Date when the supply change was initiated"},"validatedAt":{"type":"string","description":"Date when the supply change was validated","format":"date-time","nullable":true}},"required":["createdAt","updatedAt","id","assetId","status","amount","action","initiationReference","validationReference","initiatedAt","validatedAt"]},"SupplyChangeStatus":{"type":"string","enum":["approved","cancelled","completed","initiated","rejected"],"description":"Status of supply change request"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"SupplyChangeAction":{"type":"string","enum":["additionalTokenisation","initialTokenisation","issuance","redemption","supplyDecrease","supplyIncrease"],"description":"Action of supply change request"}}}}
```

## The SupplyChangeStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SupplyChangeStatus":{"type":"string","enum":["approved","cancelled","completed","initiated","rejected"],"description":"Status of supply change request"}}}}
```

## The UpdateBondSupplyChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateBondSupplyChangeDto":{"type":"object","properties":{"status":{"description":"**Update bond supply change status:**\n- `cancelled` - cancel bond supply change","allOf":[{"$ref":"#/components/schemas/SupplyChangeStatus"}]},"validationReference":{"type":"string","description":"Arbitrary reference provided by the issuer agent to the bond supply change"}},"required":["status","validationReference"]},"SupplyChangeStatus":{"type":"string","enum":["approved","cancelled","completed","initiated","rejected"],"description":"Status of supply change request"}}}}
```

## The FilterBondDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterBondDto":{"type":"object","properties":{"id":{"description":"Filter bonds by asset ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"brokerId":{"description":"Filter bonds by broker ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuerId":{"description":"Filter bonds by issuer ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuingAccountAddress":{"description":"Filter bonds by issuer account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"operationalAccountAddress":{"description":"Filter bonds by operational account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"name":{"type":"string","description":"Filter bonds by name"},"isin":{"type":"string","description":"Filter bonds by ISIN"},"ticker":{"type":"string","description":"Filter bonds by ticker"},"dti":{"type":"string","description":"Filter bonds by DTI"},"origin":{"description":"Filter bonds by origin","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/BondOrigin"},"minItems":1},{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Filter bonds by custodian"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities"},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer CSD where the securities are registered"},"underlyingInstrumentCode":{"type":"string","description":"Filter bonds by instrument code"},"fisn":{"type":"string","description":"Filter bonds by FISN","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Filter bonds by country code where the security is issued"},"seniority":{"description":"Filter bonds by seniority","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/BondSeniority"},"minItems":1},{"$ref":"#/components/schemas/BondSeniority"}]},"initialPlacement":{"description":"Filter bonds by initial placement","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/InitialPlacementType"},"minItems":1},{"$ref":"#/components/schemas/InitialPlacementType"}]},"status":{"description":"Filter bonds by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/BondStatus"},"minItems":1},{"$ref":"#/components/schemas/BondStatus"}]},"issuedAt":{"format":"date-time","description":"Filter bonds by issue date","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"settlementType":{"description":"Filter bonds by settlement type","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SettlementType"},"minItems":1},{"$ref":"#/components/schemas/SettlementType"}]}}},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"BondStatus":{"type":"string","enum":["draft","recorded","issued","distributing","live","locked","mature","collecting","collected","closed"],"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"}}}}
```

## The FilterDataValidationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterDataValidationDto":{"type":"object","properties":{"status":{"description":"Filter bond data validations by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/DataValidationStatus"},"minItems":1},{"$ref":"#/components/schemas/DataValidationStatus"}]}}},"DataValidationStatus":{"type":"string","enum":["approved","cancelled","initiated","rejected"],"description":"**Data validation status:**\n- `initiated` - data validation has been requested and is awaiting operator review\n- `approved` - operator approved the data validation\n- `rejected` - operator rejected the data validation\n- `cancelled` - data validation was cancelled by the broker"}}}}
```

## The FilterSupplyChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterSupplyChangeDto":{"type":"object","properties":{"status":{"description":"Filter supply changes by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SupplyChangeStatus"},"minItems":1},{"$ref":"#/components/schemas/SupplyChangeStatus"}]},"action":{"description":"Filter supply changes by action","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SupplyChangeAction"},"minItems":1},{"$ref":"#/components/schemas/SupplyChangeAction"}]}}},"SupplyChangeStatus":{"type":"string","enum":["approved","cancelled","completed","initiated","rejected"],"description":"Status of supply change request"},"SupplyChangeAction":{"type":"string","enum":["additionalTokenisation","initialTokenisation","issuance","redemption","supplyDecrease","supplyIncrease"],"description":"Action of supply change request"}}}}
```

## The BondAccountBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BondAccountBalanceDto":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Bond amount held by the account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"account":{"description":"Account details","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/AccountDto"}]}},"required":["accountAddress","amount","account"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"AccountDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of account","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","type":"string","description":"Opened date"}},"required":["createdAt","updatedAt","nodeId","address","type","institutionSectorCode","walletType","status","openedAt"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"}}}}
```

## The FilterBondAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterBondAccountDto":{"type":"object","properties":{"accountAddress":{"description":"Filter accounts by account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"amount":{"description":"Filter accounts by amount from number or between two numbers","oneOf":[{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1,"maxItems":2},{"type":"integer","format":"int64"}]}}}}}}
```

## The QueryBondAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryBondAccountDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get bond accounts by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The FilterBondAuctionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterBondAuctionDto":{"type":"object","properties":{"id":{"description":"Filter by single or multiple auction ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"type":{"description":"Filter by type of auction","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/AuctionType"},"minItems":1},{"$ref":"#/components/schemas/AuctionType"}]},"status":{"description":"Filter by status of auction","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/AuctionStatus"},"minItems":1},{"$ref":"#/components/schemas/AuctionStatus"}]},"startAt":{"format":"date-time","description":"Filter by auction start date and time","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"endAt":{"format":"date-time","description":"Filter by auction end date and time","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"AuctionType":{"type":"string","enum":["fixed-price","min-price"],"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive"},"AuctionStatus":{"type":"string","enum":["upcoming","open","closed","settled","failed","cancelled"],"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent"}}}}
```

## The FilterBidDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterBidDto":{"type":"object","properties":{"id":{"description":"Filter by one or more bid ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"brokerId":{"description":"Filter by one or more broker ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"status":{"description":"Filter by bid status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/BidStatus"},"minItems":1},{"$ref":"#/components/schemas/BidStatus"}]},"placedAt":{"format":"date-time","description":"Filter bids placed from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"settledAt":{"format":"date-time","description":"Filter bids settled from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"BidStatus":{"type":"string","enum":["placed","funded","matched","settled","not-matched","rejected","cancelled"],"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid"}}}}
```

## The FilterCouponDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterCouponDto":{"type":"object","properties":{"id":{"description":"Filter by coupon ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"status":{"description":"Filter by coupon status(es)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/CouponStatus"},"minItems":1},{"$ref":"#/components/schemas/CouponStatus"}]},"recordAt":{"format":"date-time","description":"Filter coupons recorded from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"payAt":{"format":"date-time","description":"Filter coupons payable from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"CouponStatus":{"type":"string","enum":["paid","readyToPay","upcoming","paying","noFunds"],"description":"Coupon status"}}}}
```

## The FilterCouponPaymentDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterCouponPaymentDto":{"type":"object","properties":{"id":{"description":"Filter by coupon payment ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"status":{"description":"Filter by coupon payment status(es)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/CouponPaymentStatus"},"minItems":1},{"$ref":"#/components/schemas/CouponPaymentStatus"}]},"receiverAddress":{"description":"Filter by partial receiver address or list of receiver addresses","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"createdAt":{"format":"date-time","description":"Filter coupon payments created from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"CouponPaymentStatus":{"type":"string","enum":["paid","unpaid"],"description":"Status of the coupon payment"}}}}
```

## The FilterDistributionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterDistributionDto":{"type":"object","properties":{"id":{"description":"Filter by distribution ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"type":{"description":"Filter by distribution type(s)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/DistributionType"},"minItems":1},{"$ref":"#/components/schemas/DistributionType"}]},"status":{"description":"Filter by distribution status(es)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/DistributionStatus"},"minItems":1},{"$ref":"#/components/schemas/DistributionStatus"}]},"reference":{"description":"Filter by reference","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string"}]},"recordedAt":{"format":"date-time","description":"Filter distributions recorded from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"settledAt":{"format":"date-time","description":"Filter distributions settled from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"DistributionType":{"type":"string","enum":["fop","dvp"],"description":"**Type of distribution:**\n- `fop` - Free Of Payment: asset units are transferred for free\n- `dvp` - Delivery Versus Payment: asset units are transferred for an agreed currency amount"},"DistributionStatus":{"type":"string","enum":["settling","settled"],"description":"**Status of distribution:**\n- `settling` - distribution created and is settling\n- `settled` - distribution settled"}}}}
```

## The InterestDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InterestDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bond interest UUID identifier, unique in scope of this node","format":"uuid"},"bondId":{"type":"string","description":"Bond UUID","format":"uuid"},"couponId":{"type":"string","description":"Coupon UUID anchoring this accrual period","format":"uuid"},"date":{"type":"string","description":"Calendar date of this interest entry (YYYY-MM-DD)"},"elapsedDays":{"type":"number","description":"Day-count numerator: elapsed days from the coupon start to this date under the bond day-count convention."},"pct":{"format":"int64","description":"Daily accrued interest, as a percentage.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"amount":{"format":"int64","description":"Daily accrued interest, in the bond currency.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"accruedPct":{"format":"int64","description":"Cumulative accrued interest inclusive of this day, as a percentage.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"accruedAmount":{"format":"int64","description":"Cumulative accrued interest inclusive of this day, in the bond currency.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]}},"required":["createdAt","updatedAt","id","bondId","couponId","date","elapsedDays","pct","amount","accruedPct","accruedAmount"]},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The FilterInterestDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterInterestDto":{"type":"object","properties":{"date":{"format":"date-time","description":"Filter by date or date range","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}}}}}
```

## The FilterBrokerDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterBrokerDto":{"type":"object","properties":{"name":{"type":"string","description":"Filter participants by name"},"leiCode":{"type":"string","description":"Filter participants by LEI code"},"companyCode":{"type":"string","description":"Filter participants by company code"},"representorCompanyCode":{"type":"string","description":"Filter participants by representor company code"},"countryCode":{"type":"string","description":"Filter participants by country code","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Filter participants by branch country code","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"institutionSectorCode":{"description":"Filter participants by institution sector code","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/InstitutionSectorCode"},"minItems":1},{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"description":"Filter participants by BIC code","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string","description":"Partial BIC code"}]},"isLiquidityProvider":{"type":"boolean","description":"Filter participants by liquidity provider status"},"ibans":{"type":"string","description":"Filter brokers by full IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34}}},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The TypedIban object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"TypedIban":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN of the wallet","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"type":{"description":"Type of the wallet","allOf":[{"$ref":"#/components/schemas/WalletType"}]}},"required":["iban","type"]},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"}}}}
```

## The BrokerDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BrokerDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"email":{"type":"string","description":"Email of a participant","format":"email","nullable":true},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"representorCompanyCode":{"type":"string","description":"Company registration number of participant representor","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$","nullable":true},"countryCode":{"type":"string","description":"Country code of the participant","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Country code of the branch","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"type":"string","description":"Bank Identifier Code (BIC)","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"isLiquidityProvider":{"type":"boolean","description":"Is participant a liquidity provider in the market","default":false},"id":{"type":"string","description":"Broker UUID identifier, global in scope of TSS","format":"uuid"},"ibans":{"description":"List of IBANs used for deposits and withdrawals","type":"array","items":{"$ref":"#/components/schemas/TypedIban"}}},"required":["createdAt","updatedAt","name","email","leiCode","companyCode","representorCompanyCode","countryCode","branchCountryCode","institutionSectorCode","bic","isLiquidityProvider","id","ibans"]},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"TypedIban":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN of the wallet","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"type":{"description":"Type of the wallet","allOf":[{"$ref":"#/components/schemas/WalletType"}]}},"required":["iban","type"]},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"}}}}
```

## The AppFeaturesDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AppFeaturesDto":{"type":"object","properties":{"access":{"type":"object","description":"Access"},"features":{"type":"object","description":"Features (not used for now)"}},"required":["access","features"]}}}}
```

## The NodeOnlineConfig object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"NodeOnlineConfig":{"type":"object","properties":{"node":{"description":"Node config","allOf":[{"$ref":"#/components/schemas/AppFeaturesDto"}]},"system":{"description":"System config","allOf":[{"$ref":"#/components/schemas/AppFeaturesDto"}]}},"required":["node","system"]},"AppFeaturesDto":{"type":"object","properties":{"access":{"type":"object","description":"Access"},"features":{"type":"object","description":"Features (not used for now)"}},"required":["access","features"]}}}}
```

## The InitiateWithdrawalDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InitiateWithdrawalDto":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Source account address to withdraw from","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount to withdraw.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"iban":{"type":"string","description":"Destination IBAN that withdrawal should be sent to","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34}},"required":["accountAddress","amount","iban"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterCurrencyDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterCurrencyDto":{"type":"object","properties":{"id":{"description":"Filter currencies by ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"name":{"type":"string","description":"Filter currencies by name"},"code":{"type":"string","description":"Filter currencies by code"},"issuerAccountAddress":{"description":"Filter issuers by account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]}}}}}}
```

## The AssetAccount object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AssetAccount":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Account balance.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["createdAt","updatedAt","address","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CurrencyExpandedDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CurrencyExpandedDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Currency UUID identifier, global in scope of TSS","format":"uuid"},"name":{"type":"string","description":"Full name of the currency"},"code":{"type":"string","description":"Unique code of the currency"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supplyLimit":{"format":"int64","description":"Maximum amount of currency allowed in circulation.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"issuingAccount":{"description":"Issuing account details with balance","allOf":[{"$ref":"#/components/schemas/AssetAccount"}]},"operationalAccount":{"description":"Operational account details with balance","allOf":[{"$ref":"#/components/schemas/AssetAccount"}]}},"required":["createdAt","updatedAt","id","name","code","exponent","supplyLimit","issuingAccountAddress","operationalAccountAddress","issuingAccount","operationalAccount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"AssetAccount":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Account balance.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["createdAt","updatedAt","address","amount"]}}}}
```

## The FilterDepositDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterDepositDto":{"type":"object","properties":{"id":{"description":"Filter by deposit ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"brokerId":{"description":"Filter by broker ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"accountAddress":{"description":"Filter by partial account address or list of account addresses","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"iban":{"description":"Filter by IBAN","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string"}]},"status":{"description":"Filter by deposit status(es)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/DepositStatus"},"minItems":1},{"$ref":"#/components/schemas/DepositStatus"}]},"transactionId":{"description":"Filter by transaction ID(s)","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string"}]},"createdAt":{"format":"date-time","description":"Filter deposits created from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"DepositStatus":{"type":"string","enum":["approved","deposited","initiated","rejected"],"description":"Status of deposit"}}}}
```

## The FilterWithdrawalDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterWithdrawalDto":{"type":"object","properties":{"id":{"description":"Filter by withdrawal ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"brokerId":{"description":"Filter by broker ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"accountAddress":{"description":"Filter by partial account address or list of account addresses","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"iban":{"description":"Filter by IBAN","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string"}]},"status":{"description":"Filter by withdrawal status(es)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/WithdrawalStatus"},"minItems":1},{"$ref":"#/components/schemas/WithdrawalStatus"}]},"transactionId":{"description":"Filter by transaction ID(s)","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string"}]},"createdAt":{"format":"date-time","description":"Filter withdrawals created from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"WithdrawalStatus":{"type":"string","enum":["failed","initiated","rejected","returned","started","withdrawn"],"description":"Status of withdrawal"}}}}
```

## The CurrencyAccountBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CurrencyAccountBalanceDto":{"type":"object","properties":{"account":{"description":"Account details","allOf":[{"$ref":"#/components/schemas/AccountDto"}]},"amount":{"format":"int64","description":"Currency amount held by the account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["account","amount"]},"AccountDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of account","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","type":"string","description":"Opened date"}},"required":["createdAt","updatedAt","nodeId","address","type","institutionSectorCode","walletType","status","openedAt"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterCurrencyAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterCurrencyAccountDto":{"type":"object","properties":{"accountAddress":{"description":"Filter accounts by account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"amount":{"description":"Filter accounts by amount from number or between two numbers","oneOf":[{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1,"maxItems":2},{"type":"integer","format":"int64"}]}}}}}}
```

## The QueryCurrencyAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryCurrencyAccountDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get currency accounts by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The EmiDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EmiDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"email":{"type":"string","description":"Email of a participant","format":"email","nullable":true},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"representorCompanyCode":{"type":"string","description":"Company registration number of participant representor","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$","nullable":true},"countryCode":{"type":"string","description":"Country code of the participant","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Country code of the branch","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"type":"string","description":"Bank Identifier Code (BIC)","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"isLiquidityProvider":{"type":"boolean","description":"Is participant a liquidity provider in the market","default":false},"id":{"type":"string","description":"Emi UUID identifier, global in scope of TSS","format":"uuid"},"iban":{"type":"string","description":"IBAN account used for (de)tokenization ","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34}},"required":["createdAt","updatedAt","name","email","leiCode","companyCode","representorCompanyCode","countryCode","branchCountryCode","institutionSectorCode","bic","isLiquidityProvider","id","iban"]},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The FilterEmiDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterEmiDto":{"type":"object","properties":{"name":{"type":"string","description":"Filter participants by name"},"leiCode":{"type":"string","description":"Filter participants by LEI code"},"companyCode":{"type":"string","description":"Filter participants by company code"},"representorCompanyCode":{"type":"string","description":"Filter participants by representor company code"},"countryCode":{"type":"string","description":"Filter participants by country code","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Filter participants by branch country code","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"institutionSectorCode":{"description":"Filter participants by institution sector code","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/InstitutionSectorCode"},"minItems":1},{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"description":"Filter participants by BIC code","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string","description":"Partial BIC code"}]},"isLiquidityProvider":{"type":"boolean","description":"Filter participants by liquidity provider status"},"iban":{"type":"string","description":"Filter EMIs by IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34}}},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The CreateEquityDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateEquityDto":{"type":"object","properties":{"name":{"type":"string","description":"A user friendly name of the asset (ex. Orange Bond)"},"totalSupply":{"format":"int64","description":"Total supply of the asset that exists amongst all platforms together.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"currencyId":{"type":"string","description":"Unique UUID of the currency in scope of this gateway provided","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of issuer in scope of this gateway","format":"uuid"},"nominalValue":{"format":"int64","description":"Price of ONE share.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issueDate":{"format":"date-time","type":"string","description":"Issue registration date"},"isin":{"type":"string","description":"An International Securities Identification Number","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]}},"required":["name","totalSupply","currencyId","issuerId","nominalValue","issueDate","ecbClassification"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."}}}}
```

## The UpdateEquityDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateEquityDto":{"type":"object","properties":{"supply":{"format":"int64","description":"Change supply of the equity to new amount (implies issuing additional equities or burning existing ones).\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"nominalValue":{"format":"int64","description":"New nominal value of the equity. If not provided, will remain the same.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"**Update equity status:**\n- `closed` - close equity","allOf":[{"$ref":"#/components/schemas/EquityStatus"}]},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"name":{"type":"string","description":"A user friendly name of the asset (ex. Orange Bond)"},"reference":{"type":"string","description":"Reference to a document or corporate action number, etc. - anything that could help relate supply or nominal value change with other context"},"recordedAt":{"format":"date-time","type":"string","description":"Day when the action was documented to be executed. This is not necessarily the day when the equity is actually changing supply or nominal value"}},"required":["reference","recordedAt"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"EquityStatus":{"type":"string","enum":["recorded","live","suspended","closed"],"description":"Status of equity"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."}}}}
```

## The EquityDeducteeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityDeducteeDto":{"type":"object","properties":{"address":{"type":"string","description":"Address of the account to deduct the equity from","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of equity to deduct from the provided account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["address","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CreateEquityDeductionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateEquityDeductionDto":{"type":"object","properties":{"reference":{"type":"string","description":"Reference to a document or corporate action number, etc. - anything that could help relate deduction actions with other context"},"recordedAt":{"format":"date-time","type":"string","description":"Day when the action was documented to be executed. This is not necessarily the day when the equity is actually deducted from the investor."},"deductees":{"description":"Array of accounts to deduct the equity from","type":"array","items":{"$ref":"#/components/schemas/EquityDeducteeDto"}}},"required":["reference","recordedAt","deductees"]},"EquityDeducteeDto":{"type":"object","properties":{"address":{"type":"string","description":"Address of the account to deduct the equity from","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of equity to deduct from the provided account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["address","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The EquityDeductionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityDeductionStatus":{"type":"string","enum":["successful","failed"],"description":"Status of equity deduction action"}}}}
```

## The EquityDeductionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityDeductionDto":{"type":"object","properties":{"id":{"type":"string","description":"Equity deduction UUID identifier, unique in scope of this node","format":"uuid"},"equityId":{"type":"string","description":"Unique UUID of the equity in scope of this gateway","format":"uuid"},"accountAddress":{"type":"string","description":"Equity`s destination address corresponding to the investor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of equity deducted from the provided investor.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Reference to a document or corporate action number, etc. - anything that could help relate deduction actions with other context"},"recordedAt":{"type":"string","description":"Day when the action was documented to be executed. This is not necessarily the day when the equity is actually deducted from the investor."},"status":{"description":"Status of equity deduction action","allOf":[{"$ref":"#/components/schemas/EquityDeductionStatus"}]}},"required":["id","equityId","accountAddress","amount","reference","recordedAt","status"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"EquityDeductionStatus":{"type":"string","enum":["successful","failed"],"description":"Status of equity deduction action"}}}}
```

## The EquityDistributeeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityDistributeeDto":{"type":"object","properties":{"address":{"type":"string","description":"Address of the account to distribute the equity to","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of equity to send to the provided receiver.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["address","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CreateEquityDistributionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateEquityDistributionDto":{"type":"object","properties":{"reference":{"type":"string","description":"Reference to a document or corporate action number, etc. - anything that could help relate distribution actions with other context"},"recordedAt":{"format":"date-time","type":"string","description":"Day when the action was documented to be executed. This is not necessarily the day when the equity is actually distributed to the investor."},"distributees":{"description":"Array of accounts to distribute the equity to","type":"array","items":{"$ref":"#/components/schemas/EquityDistributeeDto"}}},"required":["reference","recordedAt","distributees"]},"EquityDistributeeDto":{"type":"object","properties":{"address":{"type":"string","description":"Address of the account to distribute the equity to","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of equity to send to the provided receiver.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["address","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The EquityDistributionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityDistributionStatus":{"type":"string","enum":["successful","failed"],"description":"Status of equity distribution action"}}}}
```

## The EquityDistributionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityDistributionDto":{"type":"object","properties":{"id":{"type":"string","description":"Equity distribution UUID identifier, unique in scope of this node","format":"uuid"},"equityId":{"type":"string","description":"Unique UUID of the equity in scope of this gateway","format":"uuid"},"accountAddress":{"type":"string","description":"Equity`s destination address corresponding to the investor account address"},"amount":{"format":"int64","description":"Amount of equity sent to the provided investor.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Reference to a document or corporate action number, etc. - anything that could help relate distribution actions with other context"},"recordedAt":{"type":"string","description":"Day when the action was documented to be executed. This is not necessarily the day when the equity is actually distributed to the investor."},"status":{"description":"Status of equity distribution action","allOf":[{"$ref":"#/components/schemas/EquityDistributionStatus"}]}},"required":["id","equityId","accountAddress","amount","reference","recordedAt","status"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"EquityDistributionStatus":{"type":"string","enum":["successful","failed"],"description":"Status of equity distribution action"}}}}
```

## The FilterEquityDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterEquityDto":{"type":"object","properties":{"id":{"description":"Filter equities by id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"currencyId":{"description":"Filter equities by currency id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuerId":{"description":"Filter equities by issuer id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"nominalValue":{"type":"number","description":"Filter equities by nominal value"},"issueDate":{"format":"date-time","description":"Filter equities by issue date","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"status":{"description":"Filter equities by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/EquityStatus"},"minItems":1},{"$ref":"#/components/schemas/EquityStatus"}]},"issuingAccountAddress":{"description":"Filter equities by issuer address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"operationalAccountAddress":{"description":"Filter equities by operational account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"name":{"type":"string","description":"Filter equities by name"},"supply":{"description":"Filter equities by supply from number or between two numbers","oneOf":[{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1,"maxItems":2},{"type":"integer","format":"int64"}]},"specUrl":{"type":"string","description":"Filter equities by specification URL"},"isin":{"type":"string","description":"Filter equities by isin"}}},"EquityStatus":{"type":"string","enum":["recorded","live","suspended","closed"],"description":"Status of equity"}}}}
```

## The EquityAccountBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EquityAccountBalanceDto":{"type":"object","properties":{"account":{"description":"Account details","allOf":[{"$ref":"#/components/schemas/AccountDto"}]},"amount":{"format":"int64","description":"Equity amount held by the account.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["account","amount"]},"AccountDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of account","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","type":"string","description":"Opened date"}},"required":["createdAt","updatedAt","nodeId","address","type","institutionSectorCode","walletType","status","openedAt"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterEquityAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterEquityAccountDto":{"type":"object","properties":{"accountAddress":{"description":"Filter accounts by account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"amount":{"description":"Filter accounts by amount from number or between two numbers","oneOf":[{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1,"maxItems":2},{"type":"integer","format":"int64"}]}}}}}}
```

## The QueryEquityAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryEquityAccountDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get equity accounts by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The CreateFundDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateFundDto":{"type":"object","properties":{"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway to assign as this fund's issuer","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the settlement currency in scope of this gateway","format":"uuid"},"name":{"type":"string","description":"Full name of the fund"},"origin":{"allOf":[{"$ref":"#/components/schemas/InstrumentOrigin"}],"description":"Origin of the fund. MVP scope accepts only `tokenized`.","default":"tokenized"},"vehicleType":{"allOf":[{"$ref":"#/components/schemas/VehicleType"}]},"incomeUse":{"allOf":[{"$ref":"#/components/schemas/IncomeUse"}]},"managementCompanyLei":{"type":"string","description":"LEI of the fund management company","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"mmfFlag":{"type":"boolean","description":"Flag indicating this fund is a Money Market Fund unit. MVP scope requires `true`."},"mmfVariant":{"allOf":[{"$ref":"#/components/schemas/MmfVariant"}],"description":"MMF variant — required because mmfFlag is true in MVP"},"custodian":{"type":"string","description":"Custodian where asset is registered outside"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer in central securities depository","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code"},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"isin":{"type":"string","description":"International Securities Identification Number"},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$"},"figi":{"type":"string","description":"Financial Instrument Global Identifier"},"ticker":{"type":"string","description":"Ticker symbol"},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$"},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"minimumSettlementUnit":{"type":"string","description":"Up to what part a fund unit can be divided"},"settlementUnitMultiple":{"type":"string","description":"The smallest part of settlement currency to trade"},"shareClassName":{"type":"string","description":"Share class of the fund"},"managementFee":{"format":"int64","minimum":0,"maximum":100000000,"description":"Annual management fee, expressed as a percentage (0–100).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"minimumInvestment":{"type":"string","description":"Minimum investment required to subscribe to the fund"},"payoutType":{"allOf":[{"$ref":"#/components/schemas/PayoutType"}],"description":"How fund income is paid out — in settlement currency or in units"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the fund prospectus registered"},"isSubscribable":{"type":"boolean","description":"Whether the fund accepts subscriptions"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the fund."},"reference":{"type":"string","description":"Reference to the new fund data document or other relevant information."},"settlementType":{"allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"cutOffTime":{"type":"string","description":"Cut-off time — deadline to receive subscriptions","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"freezeMinutesBeforeCutOff":{"type":"number","description":"Freeze window before the cut-off, in minutes"}},"required":["issuerId","currencyId","name","origin","vehicleType","incomeUse","mmfFlag","mmfVariant","countryCode","exponent","ecbClassification","bolClassification","minimumSettlementUnit","settlementUnitMultiple","shareClassName","managementFee","minimumInvestment","payoutType","prospectusRegistered","isSubscribable","issuedAt","reference","settlementType","cutOffTime","freezeMinutesBeforeCutOff"]},"InstrumentOrigin":{"type":"string","enum":["native","tokenized"],"description":"**Origin of the fund:**\n- `native` - fund originally issued on Axiology TSS\n- `tokenized` - immobilised external fund tokenised on Axiology TSS"},"VehicleType":{"type":"string","enum":["UCITS sub-fund","AIF","Securitisation compartment","Standalone fund"],"description":"**Vehicle type of the fund:**\n- `UCITS sub-fund` - sub-fund of a UCITS umbrella\n- `AIF` - alternative investment fund\n- `Securitisation compartment` - compartment of a securitisation vehicle\n- `Standalone fund` - standalone fund without an umbrella structure"},"IncomeUse":{"type":"string","enum":["accumulating","distributing"],"description":"**Income use policy of the fund:**\n- `accumulating` - income is reinvested into the fund's NAV\n- `distributing` - income is paid out to unit-holders"},"MmfVariant":{"type":"string","enum":["CNAV","LVNAV","VNAV","Short-Term VNAV"],"description":"**Money Market Fund variant:**\n- `CNAV` - Constant Net Asset Value\n- `LVNAV` - Low-Volatility Net Asset Value\n- `VNAV` - Variable Net Asset Value\n- `Short-Term VNAV` - Short-Term Variable Net Asset Value"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"PayoutType":{"type":"string","enum":["currency","units"],"description":"**How the fund pays out income:**\n- `currency` - paid out in the settlement currency\n- `units` - reinvested as fund units"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"}}}}
```

## The CreateFundInterestDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateFundInterestDto":{"type":"object","properties":{"date":{"format":"date","type":"string","description":"Date the interest record applies to"},"recordAt":{"format":"date-time","type":"string","description":"Point in time used to determine fund holders and their balances"},"totalAccrued":{"format":"int64","description":"Total interest accrued by the fund for the day\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["date","recordAt","totalAccrued"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FundInterestDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FundInterestDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Interest id","format":"uuid"},"fundId":{"type":"string","description":"Fund id","format":"uuid"},"date":{"type":"string","description":"Date the interest record applies to","format":"date"},"recordAt":{"format":"date-time","type":"string","description":"Point in time used to determine fund holders and their balances"},"totalAccrued":{"format":"int64","description":"Total interest accrued by the fund for the day\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["createdAt","updatedAt","id","fundId","date","recordAt","totalAccrued"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CreateFundDataValidationSpecDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateFundDataValidationSpecDto":{"type":"object","properties":{"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway to assign as this fund's issuer","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the settlement currency in scope of this gateway","format":"uuid"},"name":{"type":"string","description":"Full name of the fund"},"origin":{"allOf":[{"$ref":"#/components/schemas/InstrumentOrigin"}],"description":"Origin of the fund. MVP scope accepts only `tokenized`.","default":"tokenized"},"vehicleType":{"allOf":[{"$ref":"#/components/schemas/VehicleType"}]},"incomeUse":{"allOf":[{"$ref":"#/components/schemas/IncomeUse"}]},"managementCompanyLei":{"type":"string","description":"LEI of the fund management company","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"mmfFlag":{"type":"boolean","description":"Flag indicating this fund is a Money Market Fund unit. MVP scope requires `true`."},"mmfVariant":{"allOf":[{"$ref":"#/components/schemas/MmfVariant"}],"description":"MMF variant — required because mmfFlag is true in MVP"},"custodian":{"type":"string","description":"Custodian where asset is registered outside"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer in central securities depository","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code"},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"isin":{"type":"string","description":"International Securities Identification Number"},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$"},"figi":{"type":"string","description":"Financial Instrument Global Identifier"},"ticker":{"type":"string","description":"Ticker symbol"},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$"},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"minimumSettlementUnit":{"type":"string","description":"Up to what part a fund unit can be divided"},"settlementUnitMultiple":{"type":"string","description":"The smallest part of settlement currency to trade"},"shareClassName":{"type":"string","description":"Share class of the fund"},"managementFee":{"format":"int64","minimum":0,"maximum":100000000,"description":"Annual management fee, expressed as a percentage (0–100).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"minimumInvestment":{"type":"string","description":"Minimum investment required to subscribe to the fund"},"payoutType":{"allOf":[{"$ref":"#/components/schemas/PayoutType"}],"description":"How fund income is paid out — in settlement currency or in units"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the fund prospectus registered"},"isSubscribable":{"type":"boolean","description":"Whether the fund accepts subscriptions"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the fund."},"settlementType":{"allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"cutOffTime":{"type":"string","description":"Cut-off time — deadline to receive subscriptions","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"freezeMinutesBeforeCutOff":{"type":"number","description":"Freeze window before the cut-off, in minutes"}},"required":["issuerId","currencyId","name","origin","vehicleType","incomeUse","mmfFlag","mmfVariant","countryCode","exponent","ecbClassification","bolClassification","minimumSettlementUnit","settlementUnitMultiple","shareClassName","managementFee","minimumInvestment","payoutType","prospectusRegistered","isSubscribable","issuedAt","settlementType","cutOffTime","freezeMinutesBeforeCutOff"]},"InstrumentOrigin":{"type":"string","enum":["native","tokenized"],"description":"**Origin of the fund:**\n- `native` - fund originally issued on Axiology TSS\n- `tokenized` - immobilised external fund tokenised on Axiology TSS"},"VehicleType":{"type":"string","enum":["UCITS sub-fund","AIF","Securitisation compartment","Standalone fund"],"description":"**Vehicle type of the fund:**\n- `UCITS sub-fund` - sub-fund of a UCITS umbrella\n- `AIF` - alternative investment fund\n- `Securitisation compartment` - compartment of a securitisation vehicle\n- `Standalone fund` - standalone fund without an umbrella structure"},"IncomeUse":{"type":"string","enum":["accumulating","distributing"],"description":"**Income use policy of the fund:**\n- `accumulating` - income is reinvested into the fund's NAV\n- `distributing` - income is paid out to unit-holders"},"MmfVariant":{"type":"string","enum":["CNAV","LVNAV","VNAV","Short-Term VNAV"],"description":"**Money Market Fund variant:**\n- `CNAV` - Constant Net Asset Value\n- `LVNAV` - Low-Volatility Net Asset Value\n- `VNAV` - Variable Net Asset Value\n- `Short-Term VNAV` - Short-Term Variable Net Asset Value"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"PayoutType":{"type":"string","enum":["currency","units"],"description":"**How the fund pays out income:**\n- `currency` - paid out in the settlement currency\n- `units` - reinvested as fund units"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"}}}}
```

## The CreateFundDataValidationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateFundDataValidationDto":{"type":"object","properties":{"initiationReference":{"type":"string","description":"Arbitrary reference provided by the broker to the fund data validation initiation"},"spec":{"description":"Proposed fund data to validate","allOf":[{"$ref":"#/components/schemas/CreateFundDataValidationSpecDto"}]}},"required":["initiationReference","spec"]},"CreateFundDataValidationSpecDto":{"type":"object","properties":{"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway to assign as this fund's issuer","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the settlement currency in scope of this gateway","format":"uuid"},"name":{"type":"string","description":"Full name of the fund"},"origin":{"allOf":[{"$ref":"#/components/schemas/InstrumentOrigin"}],"description":"Origin of the fund. MVP scope accepts only `tokenized`.","default":"tokenized"},"vehicleType":{"allOf":[{"$ref":"#/components/schemas/VehicleType"}]},"incomeUse":{"allOf":[{"$ref":"#/components/schemas/IncomeUse"}]},"managementCompanyLei":{"type":"string","description":"LEI of the fund management company","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"mmfFlag":{"type":"boolean","description":"Flag indicating this fund is a Money Market Fund unit. MVP scope requires `true`."},"mmfVariant":{"allOf":[{"$ref":"#/components/schemas/MmfVariant"}],"description":"MMF variant — required because mmfFlag is true in MVP"},"custodian":{"type":"string","description":"Custodian where asset is registered outside"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer in central securities depository","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code"},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"isin":{"type":"string","description":"International Securities Identification Number"},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$"},"figi":{"type":"string","description":"Financial Instrument Global Identifier"},"ticker":{"type":"string","description":"Ticker symbol"},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$"},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"minimumSettlementUnit":{"type":"string","description":"Up to what part a fund unit can be divided"},"settlementUnitMultiple":{"type":"string","description":"The smallest part of settlement currency to trade"},"shareClassName":{"type":"string","description":"Share class of the fund"},"managementFee":{"format":"int64","minimum":0,"maximum":100000000,"description":"Annual management fee, expressed as a percentage (0–100).\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"minimumInvestment":{"type":"string","description":"Minimum investment required to subscribe to the fund"},"payoutType":{"allOf":[{"$ref":"#/components/schemas/PayoutType"}],"description":"How fund income is paid out — in settlement currency or in units"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the fund prospectus registered"},"isSubscribable":{"type":"boolean","description":"Whether the fund accepts subscriptions"},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the fund."},"settlementType":{"allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"cutOffTime":{"type":"string","description":"Cut-off time — deadline to receive subscriptions","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"freezeMinutesBeforeCutOff":{"type":"number","description":"Freeze window before the cut-off, in minutes"}},"required":["issuerId","currencyId","name","origin","vehicleType","incomeUse","mmfFlag","mmfVariant","countryCode","exponent","ecbClassification","bolClassification","minimumSettlementUnit","settlementUnitMultiple","shareClassName","managementFee","minimumInvestment","payoutType","prospectusRegistered","isSubscribable","issuedAt","settlementType","cutOffTime","freezeMinutesBeforeCutOff"]},"InstrumentOrigin":{"type":"string","enum":["native","tokenized"],"description":"**Origin of the fund:**\n- `native` - fund originally issued on Axiology TSS\n- `tokenized` - immobilised external fund tokenised on Axiology TSS"},"VehicleType":{"type":"string","enum":["UCITS sub-fund","AIF","Securitisation compartment","Standalone fund"],"description":"**Vehicle type of the fund:**\n- `UCITS sub-fund` - sub-fund of a UCITS umbrella\n- `AIF` - alternative investment fund\n- `Securitisation compartment` - compartment of a securitisation vehicle\n- `Standalone fund` - standalone fund without an umbrella structure"},"IncomeUse":{"type":"string","enum":["accumulating","distributing"],"description":"**Income use policy of the fund:**\n- `accumulating` - income is reinvested into the fund's NAV\n- `distributing` - income is paid out to unit-holders"},"MmfVariant":{"type":"string","enum":["CNAV","LVNAV","VNAV","Short-Term VNAV"],"description":"**Money Market Fund variant:**\n- `CNAV` - Constant Net Asset Value\n- `LVNAV` - Low-Volatility Net Asset Value\n- `VNAV` - Variable Net Asset Value\n- `Short-Term VNAV` - Short-Term Variable Net Asset Value"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"PayoutType":{"type":"string","enum":["currency","units"],"description":"**How the fund pays out income:**\n- `currency` - paid out in the settlement currency\n- `units` - reinvested as fund units"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"}}}}
```

## The UpdateFundDataValidationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateFundDataValidationDto":{"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/DataValidationStatus"}],"description":"**Fund data validation status**\n- `cancelled` - cancel fund data validation","default":"cancelled"},"validationReference":{"type":"string","description":"Arbitrary reference provided by the broker to the fund data validation"}},"required":["status","validationReference"]},"DataValidationStatus":{"type":"string","enum":["approved","cancelled","initiated","rejected"],"description":"**Data validation status:**\n- `initiated` - data validation has been requested and is awaiting operator review\n- `approved` - operator approved the data validation\n- `rejected` - operator rejected the data validation\n- `cancelled` - data validation was cancelled by the broker"}}}}
```

## The CreateRedemptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateRedemptionDto":{"type":"object","properties":{"fundId":{"type":"string","description":"Fund (asset) id to redeem from","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"amount":{"format":"int64","description":"Amount of fund units to redeem\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Optional reference stored against the redemption request","maxLength":256}},"required":["fundId","accountAddress","cashLegType","amount"]},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The UpdateRedemptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateRedemptionDto":{"type":"object","properties":{"status":{"description":"**Update fund redemption status:**\n- `settled` - (issuer agent) settle the redemption\n- `rejected` - (issuer agent) reject the redemption\n- `cancelled` - (investor agent) cancel the redemption","allOf":[{"$ref":"#/components/schemas/RedemptionStatus"}]},"totalPrice":{"format":"int64","description":"Settled cash proceeds, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Optional reference stored against this status change","maxLength":256}},"required":["status"]},"RedemptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund redemption status:**\n- `requested` - redemption requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; cash delivered to the investor"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CreateSubscriptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateSubscriptionDto":{"type":"object","properties":{"fundId":{"type":"string","description":"Fund (asset) id to subscribe to","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"totalPrice":{"format":"int64","description":"Requested price, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"format":"int64","description":"Requested amount, in fund units\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Optional reference stored against the subscription request","maxLength":256}},"required":["fundId","accountAddress","cashLegType"]},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The UpdateSubscriptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateSubscriptionDto":{"type":"object","properties":{"status":{"description":"**Update fund subscription status:**\n- `settled` - (issuer agent) settle the subscription\n- `rejected` - (issuer agent) reject the subscription\n- `cancelled` - (investor agent) cancel the subscription","allOf":[{"$ref":"#/components/schemas/SubscriptionStatus"}]},"totalPrice":{"format":"int64","description":"Settled price, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"format":"int64","description":"Settled amount, in fund units\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Optional reference stored against this status change","maxLength":256}},"required":["status"]},"SubscriptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund subscription status:**\n- `requested` - subscription requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; units delivered to the investor"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CreateFundSupplyChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateFundSupplyChangeDto":{"type":"object","properties":{"amount":{"format":"int64","description":"Signed change in fund supply. Positive for tokenisation/increase, negative for redemption/decrease.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"action":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeAction"}]},"initiationReference":{"type":"string","description":"Arbitrary reference provided by the broker to the fund supply change initiation."}},"required":["amount","action","initiationReference"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"SupplyChangeAction":{"type":"string","enum":["additionalTokenisation","initialTokenisation","issuance","redemption","supplyDecrease","supplyIncrease"],"description":"Action of supply change request"}}}}
```

## The UpdateFundSupplyChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateFundSupplyChangeDto":{"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeStatus"}],"description":"**Update fund supply change status:**\n- `cancelled` - cancel fund supply change","default":"cancelled"},"validationReference":{"type":"string","description":"Arbitrary reference provided by the broker to the fund supply change cancellation"}},"required":["status","validationReference"]},"SupplyChangeStatus":{"type":"string","enum":["approved","cancelled","completed","initiated","rejected"],"description":"Status of supply change request"}}}}
```

## The CreateValuationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateValuationDto":{"type":"object","properties":{"navDate":{"format":"date","type":"string","description":"NAV date the record applies to"},"navPrice":{"format":"int64","description":"NAV price per unit\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"marketNavPrice":{"format":"int64","description":"Mark-to-market NAV price per unit\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"wam":{"type":"number","description":"Weighted average maturity in days"},"wal":{"type":"number","description":"Weighted average life in days"},"oneDayYield":{"format":"int64","description":"Annualised 1-day yield, may be negative\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"totalNetAsset":{"format":"int64","description":"Total fund AUM\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"availableNetAsset":{"format":"int64","description":"Fund net assets available (e.g. for redemption)\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Arbitrary reference provided by the broker"}},"required":["navDate","navPrice"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The ValuationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ValuationDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Valuation UUID identifier, global in scope of TSS","format":"uuid"},"fundId":{"type":"string","description":"Fund id","format":"uuid"},"navDate":{"type":"string","description":"NAV date the record applies to","format":"date"},"navPrice":{"format":"int64","description":"NAV price per unit\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"marketNavPrice":{"nullable":true,"description":"Mark-to-market NAV price per unit\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"wam":{"type":"number","description":"Weighted average maturity in days","nullable":true},"wal":{"type":"number","description":"Weighted average life in days","nullable":true},"oneDayYield":{"nullable":true,"description":"Annualised 1-day yield, may be negative\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"totalNetAsset":{"nullable":true,"description":"Total fund AUM\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"availableNetAsset":{"nullable":true,"description":"Fund net assets available (e.g. for redemption)\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"reference":{"type":"string","description":"Arbitrary reference provided by the broker","nullable":true},"recordedAt":{"format":"date-time","type":"string","description":"System-assigned timestamp recorded on the TSS"},"deletedAt":{"type":"string","description":"Deletion timestamp; null while the valuation is active","format":"date-time","nullable":true}},"required":["createdAt","updatedAt","id","fundId","navDate","navPrice","marketNavPrice","wam","wal","oneDayYield","totalNetAsset","availableNetAsset","reference","recordedAt","deletedAt"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The FundAccountBalanceDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FundAccountBalanceDto":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Fund amount held by the account.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"account":{"description":"Account details","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/AccountDto"}]}},"required":["accountAddress","amount","account"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"AccountDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of account","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","type":"string","description":"Opened date"}},"required":["createdAt","updatedAt","nodeId","address","type","institutionSectorCode","walletType","status","openedAt"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"}}}}
```

## The FilterFundAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterFundAccountDto":{"type":"object","properties":{"accountAddress":{"description":"Filter accounts by account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"amount":{"description":"Filter accounts by amount from number or between two numbers","oneOf":[{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1,"maxItems":2},{"type":"integer","format":"int64"}]}}}}}}
```

## The QueryFundAccountDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"QueryFundAccountDto":{"type":"object","properties":{"heldAt":{"format":"date-time","type":"string","description":"Get fund accounts by the end day they were held. (skip the property for current holdings)"}}}}}}
```

## The InterestAllocationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InterestAllocationDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Allocation UUID identifier, global in scope of TSS","format":"uuid"},"interestId":{"type":"string","description":"Id of the interest this allocation belongs to","format":"uuid"},"accountAddress":{"type":"string","description":"Account address of the investor holding fund units at the interest record timestamp"},"fundAmount":{"format":"int64","description":"Fund amount held by the account address at the interest record timestamp\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"payoutAmount":{"format":"int64","description":"Part of the total interest payment allocated to the account address\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]}},"required":["createdAt","updatedAt","id","interestId","accountAddress","fundAmount","payoutAmount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterInterestAllocationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterInterestAllocationDto":{"type":"object","properties":{"accountAddress":{"description":"Filter by partial account address or list of account addresses","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"date":{"format":"date-time","description":"Filter by calendar date or date range","oneOf":[{"type":"array","items":{"type":"string","format":"date"},"minItems":1,"maxItems":2},{"type":"string","format":"date"}]}}}}}}
```

## The FilterFundInterestDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterFundInterestDto":{"type":"object","properties":{"date":{"format":"date-time","description":"Filter by calendar date or date range","oneOf":[{"type":"array","items":{"type":"string","format":"date"},"minItems":1,"maxItems":2},{"type":"string","format":"date"}]}}}}}}
```

## The FilterRedemptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterRedemptionDto":{"type":"object","properties":{"fundId":{"description":"Filter redemptions by fund (asset) id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"accountAddress":{"description":"Filter redemptions by investor wallet address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"investorBrokerId":{"description":"Filter redemptions by investor's broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuerBrokerId":{"description":"Filter redemptions by issuer broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"cashLegType":{"description":"Filter redemptions by cash leg settlement method","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SettlementMethod"},"minItems":1},{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Filter redemptions by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/RedemptionStatus"},"minItems":1},{"$ref":"#/components/schemas/RedemptionStatus"}]}}},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"RedemptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund redemption status:**\n- `requested` - redemption requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; cash delivered to the investor"}}}}
```

## The FilterValuationDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterValuationDto":{"type":"object","properties":{"navDate":{"format":"date-time","description":"Filter by calendar date or date range","oneOf":[{"type":"array","items":{"type":"string","format":"date"},"minItems":1,"maxItems":2},{"type":"string","format":"date"}]},"deletedAt":{"format":"date-time","description":"Filter by deletion date or date range; pass null to return only active valuations","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}],"nullable":true}}}}}}
```

## The FilterFundDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterFundDto":{"type":"object","properties":{"id":{"description":"Filter funds by asset ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"brokerId":{"description":"Filter funds by broker ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuerId":{"description":"Filter funds by issuer ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuingAccountAddress":{"description":"Filter funds by issuer account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"operationalAccountAddress":{"description":"Filter funds by operational account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"name":{"type":"string","description":"Filter funds by name"},"isin":{"type":"string","description":"Filter funds by ISIN"},"ticker":{"type":"string","description":"Filter funds by ticker"},"dti":{"type":"string","description":"Filter funds by DTI"},"origin":{"description":"Filter funds by origin","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/InstrumentOrigin"},"minItems":1},{"$ref":"#/components/schemas/InstrumentOrigin"}]},"custodian":{"type":"string","description":"Filter funds by custodian"},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities"},"issuerCsdLeiCode":{"type":"string","description":"LEI code of the issuer CSD where the securities are registered"},"underlyingInstrumentCode":{"type":"string","description":"Filter funds by instrument code"},"fisn":{"type":"string","description":"Filter funds by FISN","format":"iso-18774-fisn","maxLength":35},"countryCode":{"type":"string","description":"Filter funds by country code"},"vehicleType":{"description":"Filter funds by vehicle type","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/VehicleType"},"minItems":1},{"$ref":"#/components/schemas/VehicleType"}]},"incomeUse":{"description":"Filter funds by income use","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/IncomeUse"},"minItems":1},{"$ref":"#/components/schemas/IncomeUse"}]},"mmfFlag":{"type":"boolean","description":"Filter funds by MMF flag"},"isSubscribable":{"type":"boolean","description":"Filter funds by whether they are currently subscribable"},"mmfVariant":{"description":"Filter funds by MMF variant","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/MmfVariant"},"minItems":1},{"$ref":"#/components/schemas/MmfVariant"}]},"status":{"description":"Filter funds by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/FundStatus"},"minItems":1},{"$ref":"#/components/schemas/FundStatus"}]},"issuedAt":{"format":"date-time","description":"Filter funds by issue date","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"settlementType":{"description":"Filter funds by settlement type","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SettlementType"},"minItems":1},{"$ref":"#/components/schemas/SettlementType"}]}}},"InstrumentOrigin":{"type":"string","enum":["native","tokenized"],"description":"**Origin of the fund:**\n- `native` - fund originally issued on Axiology TSS\n- `tokenized` - immobilised external fund tokenised on Axiology TSS"},"VehicleType":{"type":"string","enum":["UCITS sub-fund","AIF","Securitisation compartment","Standalone fund"],"description":"**Vehicle type of the fund:**\n- `UCITS sub-fund` - sub-fund of a UCITS umbrella\n- `AIF` - alternative investment fund\n- `Securitisation compartment` - compartment of a securitisation vehicle\n- `Standalone fund` - standalone fund without an umbrella structure"},"IncomeUse":{"type":"string","enum":["accumulating","distributing"],"description":"**Income use policy of the fund:**\n- `accumulating` - income is reinvested into the fund's NAV\n- `distributing` - income is paid out to unit-holders"},"MmfVariant":{"type":"string","enum":["CNAV","LVNAV","VNAV","Short-Term VNAV"],"description":"**Money Market Fund variant:**\n- `CNAV` - Constant Net Asset Value\n- `LVNAV` - Low-Volatility Net Asset Value\n- `VNAV` - Variable Net Asset Value\n- `Short-Term VNAV` - Short-Term Variable Net Asset Value"},"FundStatus":{"type":"string","enum":["draft","live","locked","collecting","collected","closed"],"description":"Lifecycle status of the fund"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"}}}}
```

## The IssuerType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"IssuerType":{"type":"string","enum":["bank","government","investment-holding-company","other","plc","pllc","small-pllc","sole-proprietorship"],"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer"}}}}
```

## The CreateIssuerDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateIssuerDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the company issuing the asset","minLength":1,"maxLength":256},"type":{"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer","allOf":[{"$ref":"#/components/schemas/IssuerType"}]},"companyCode":{"type":"string","description":"Company registry code or another unique identifier of the company/institution issuing the asset","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"address":{"type":"string","description":"Address of headquarters"},"postalAddress":{"type":"string","description":"Postal address"},"countryCode":{"type":"string","description":"Country code of where the issuing company is located","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"vatCode":{"type":"string","description":"Value-added tax identification number","format":"vat-code"},"email":{"type":"string","description":"Email of the issuing company’s representative","format":"email"},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"ratingAgency":{"type":"string","description":"Rating agency that has rated the issuing company"},"rating":{"type":"string","description":"Rating of the issuing company"}},"required":["name","type","companyCode","address","countryCode","institutionSectorCode"]},"IssuerType":{"type":"string","enum":["bank","government","investment-holding-company","other","plc","pllc","small-pllc","sole-proprietorship"],"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The IssuerDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"IssuerDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Issuer UUID identifier, unique in scope of this node","format":"uuid"},"type":{"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer","allOf":[{"$ref":"#/components/schemas/IssuerType"}]},"accountAddress":{"type":"string","description":"Issuer account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"address":{"type":"string","description":"Address of headquarters"},"postalAddress":{"type":"string","description":"Address of headquarters"},"countryCode":{"type":"string","description":"Country code of where the issuing company is located","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"leiCode":{"type":"string","description":"Unique identifier of the company/institution issuing the asset (LEI - Legal Entity Identifier)","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"vatCode":{"type":"string","description":"Value-added tax identification number","format":"vat-code","nullable":true},"email":{"type":"string","description":"Email of the issuing company’s representative","format":"email","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"ratingAgency":{"type":"string","nullable":true},"rating":{"type":"string","nullable":true}},"required":["createdAt","updatedAt","id","type","accountAddress","name","companyCode","address","postalAddress","countryCode","leiCode","vatCode","email","institutionSectorCode","ratingAgency","rating"]},"IssuerType":{"type":"string","enum":["bank","government","investment-holding-company","other","plc","pllc","small-pllc","sole-proprietorship"],"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The UpdateIssuerDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateIssuerDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the company issuing the asset","minLength":1,"maxLength":256},"type":{"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer","allOf":[{"$ref":"#/components/schemas/IssuerType"}]},"companyCode":{"type":"string","description":"Company registry code or another unique identifier of the company/institution issuing the asset","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"address":{"type":"string","description":"Address of headquarters"},"postalAddress":{"type":"string","description":"Postal address","nullable":true},"countryCode":{"type":"string","description":"Country code of where the issuing company is located","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"vatCode":{"type":"string","description":"Unique identifier of the company/institution issuing the asset (VAT)","format":"vat-code"},"email":{"type":"string","description":"Email of the issuing company’s representative","format":"email","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"ratingAgency":{"type":"string","description":"Rating agency that has rated the issuing company","nullable":true},"rating":{"type":"string","description":"Rating of the issuing company","nullable":true}}},"IssuerType":{"type":"string","enum":["bank","government","investment-holding-company","other","plc","pllc","small-pllc","sole-proprietorship"],"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The FilterIssuerDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterIssuerDto":{"type":"object","properties":{"id":{"description":"Filter issuers by ids","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"accountAddress":{"description":"Filter issuers by account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"name":{"type":"string","description":"Filter issuers by name"},"address":{"type":"string","description":"Filter issuers by address"},"companyCode":{"type":"string","description":"Filter issuers by company code"},"leiCode":{"type":"string","description":"Filter issuers by LEI code"},"countryCode":{"type":"string","description":"Filter issuers by country code"},"type":{"description":"Filter issuers by type","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/IssuerType"},"minItems":1},{"$ref":"#/components/schemas/IssuerType"}]},"createdAt":{"format":"date-time","description":"Filter issuers by date","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"IssuerType":{"type":"string","enum":["bank","government","investment-holding-company","other","plc","pllc","small-pllc","sole-proprietorship"],"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer"}}}}
```

## The OrderType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OrderType":{"type":"string","enum":["limit","market"],"description":"Type of the order execution"}}}}
```

## The OrderSide object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OrderSide":{"type":"string","enum":["buy","sell"],"description":"Side of the order indicating buy or sell"}}}}
```

## The PlaceOrderDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PlaceOrderDto":{"type":"object","properties":{"accountAddress":{"type":"string","description":"Investment account address that is placing the order","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of the order execution","allOf":[{"$ref":"#/components/schemas/OrderType"}]},"side":{"description":"Side of the order indicating buy or sell","allOf":[{"$ref":"#/components/schemas/OrderSide"}]},"amount":{"format":"int64","minimum":1,"description":"Amount of the base asset to trade.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"price":{"format":"int64","minimum":1,"description":"Price per unit of the base asset. Required for limit orders.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"expiresAt":{"format":"date-time","type":"string","description":"Optional expiration date of the order, defaults to 30 days from creation if not provided"}},"required":["accountAddress","type","side","amount"]},"OrderType":{"type":"string","enum":["limit","market"],"description":"Type of the order execution"},"OrderSide":{"type":"string","enum":["buy","sell"],"description":"Side of the order indicating buy or sell"},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The OrderStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OrderStatus":{"type":"string","enum":["open","filled","rejected","cancelled","expired"],"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled"}}}}
```

## The OrderCancelledReason object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OrderCancelledReason":{"type":"string","enum":["broker","listing-delisted","bond-locked"],"description":"**Order cancelled reason:**\n- `broker`: Order is cancelled by broker\n- `listing-delisted`: Order is cancelled by system because of delisted listing"}}}}
```

## The OrderDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OrderDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Order UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market identifier where the order is placed","format":"uuid"},"listingId":{"type":"string","description":"Identifier of the market listing (trading pair)","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset identifier in the trading pair","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset identifier in the trading pair","format":"uuid"},"accountAddress":{"type":"string","description":"Investment account address that placed the order","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"**Order execution strategy:**\n- `limit`: Executes at a specified price or better\n- `market`: Executes immediately at the best available price","allOf":[{"$ref":"#/components/schemas/OrderType"}]},"side":{"description":"**Side of the order indicating intent to buy or sell.**\n- `buy`: Order to purchase the base asset using the quote asset\n- `sell`: Order to sell the base asset in exchange for the quote asset","allOf":[{"$ref":"#/components/schemas/OrderSide"}]},"status":{"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled","allOf":[{"$ref":"#/components/schemas/OrderStatus"}]},"amount":{"format":"int64","description":"Amount of the base asset to trade.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"filledAmount":{"format":"int64","description":"Amount of the base asset that is filled.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"price":{"format":"int64","description":"Price per unit of the base asset, denominated in the quote asset.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"placedAt":{"format":"date-time","type":"string","description":"Placement date of the order"},"cancelledAt":{"format":"date-time","type":"string","description":"Cancellation date of the order","nullable":true},"cancelledReason":{"description":"**Order cancelled reason:**\n- `broker`: Order is cancelled by broker\n- `listing-delisted`: Order is cancelled by system because of delisted listing","nullable":true,"allOf":[{"$ref":"#/components/schemas/OrderCancelledReason"}]},"expiresAt":{"format":"date-time","type":"string","description":"Expiration date of the order","nullable":true}},"required":["createdAt","updatedAt","id","marketId","listingId","baseAssetId","quoteAssetId","accountAddress","type","side","status","amount","filledAmount","price","placedAt","cancelledAt","cancelledReason","expiresAt"]},"OrderType":{"type":"string","enum":["limit","market"],"description":"Type of the order execution"},"OrderSide":{"type":"string","enum":["buy","sell"],"description":"Side of the order indicating buy or sell"},"OrderStatus":{"type":"string","enum":["open","filled","rejected","cancelled","expired"],"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled"},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"OrderCancelledReason":{"type":"string","enum":["broker","listing-delisted","bond-locked"],"description":"**Order cancelled reason:**\n- `broker`: Order is cancelled by broker\n- `listing-delisted`: Order is cancelled by system because of delisted listing"}}}}
```

## The UpdateOrderDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateOrderDto":{"type":"object","properties":{"status":{"description":"New status of the order","allOf":[{"$ref":"#/components/schemas/OrderStatus"}]}},"required":["status"]},"OrderStatus":{"type":"string","enum":["open","filled","rejected","cancelled","expired"],"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled"}}}}
```

## The MarketStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketStatus":{"type":"string","enum":["open","closed","halted"],"description":"**Status of the market:**\n- `open` - market is open and accepting trades\n- `closed` - market is closed and not accepting trades\n- `halted` - market is halted and not accepting trades, until unhalted"}}}}
```

## The MarketClosureReason object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketClosureReason":{"type":"string","enum":["holiday","non-trading-hours","post-halt","scheduled-maintenance"],"description":"**Market closure reason (required if market is closed)**\n- `holiday` - market is closed due to holiday\n- `non-trading-hours` - market is closed due to non-trading hours (e.g. overnight, weekends, etc)\n- `post-halt` - market is closed because a halt has just ended within working hours; the market will be automatically reopened on the next scheduler tick. System-set only.\n- `scheduled-maintenance` - market is closed due to scheduled maintenance"}}}}
```

## The WorkHoursDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"WorkHoursDto":{"type":"object","properties":{"open":{"type":"string","description":"Opening time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"close":{"type":"string","description":"Closing time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5}},"required":["open","close"]}}}}
```

## The WeeklyWorkHoursDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"WeeklyWorkHoursDto":{"type":"object","properties":{"monday":{"description":"Monday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"tuesday":{"description":"Tuesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"wednesday":{"description":"Wednesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"thursday":{"description":"Thursday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"friday":{"description":"Friday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"saturday":{"description":"Saturday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"sunday":{"description":"Sunday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]}}},"WorkHoursDto":{"type":"object","properties":{"open":{"type":"string","description":"Opening time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"close":{"type":"string","description":"Closing time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5}},"required":["open","close"]}}}}
```

## The MarketDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketDto":{"type":"object","properties":{"status":{"description":"**Status of the market:**\n- `open` - market is open and accepting trades\n- `closed` - market is closed and not accepting trades\n- `halted` - market is halted and not accepting trades, until unhalted","allOf":[{"$ref":"#/components/schemas/MarketStatus"}]},"closureReason":{"description":"**Market closure reason (required if market is closed)**\n- `holiday` - market is closed due to holiday\n- `non-trading-hours` - market is closed due to non-trading hours (e.g. overnight, weekends, etc)\n- `post-halt` - market is closed because a halt has just ended within working hours; the market will be automatically reopened on the next scheduler tick. System-set only.\n- `scheduled-maintenance` - market is closed due to scheduled maintenance","allOf":[{"$ref":"#/components/schemas/MarketClosureReason"}]},"name":{"type":"string","description":"Name of the market"},"identifierCode":{"type":"string","description":"Market Identifier Code (MIC) as per ISO 10383 standard","pattern":"^[A-Z]{4}$","format":"iso-10383","minLength":4,"maxLength":4},"tz":{"type":"string","description":"Time zone (IANA) that market operates in","format":"iana-time-zone"},"workingHours":{"description":"Working hours on weekly basis","allOf":[{"$ref":"#/components/schemas/WeeklyWorkHoursDto"}]}},"required":["status","closureReason","name","identifierCode","tz","workingHours"]},"MarketStatus":{"type":"string","enum":["open","closed","halted"],"description":"**Status of the market:**\n- `open` - market is open and accepting trades\n- `closed` - market is closed and not accepting trades\n- `halted` - market is halted and not accepting trades, until unhalted"},"MarketClosureReason":{"type":"string","enum":["holiday","non-trading-hours","post-halt","scheduled-maintenance"],"description":"**Market closure reason (required if market is closed)**\n- `holiday` - market is closed due to holiday\n- `non-trading-hours` - market is closed due to non-trading hours (e.g. overnight, weekends, etc)\n- `post-halt` - market is closed because a halt has just ended within working hours; the market will be automatically reopened on the next scheduler tick. System-set only.\n- `scheduled-maintenance` - market is closed due to scheduled maintenance"},"WeeklyWorkHoursDto":{"type":"object","properties":{"monday":{"description":"Monday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"tuesday":{"description":"Tuesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"wednesday":{"description":"Wednesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"thursday":{"description":"Thursday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"friday":{"description":"Friday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"saturday":{"description":"Saturday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"sunday":{"description":"Sunday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]}}},"WorkHoursDto":{"type":"object","properties":{"open":{"type":"string","description":"Opening time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"close":{"type":"string","description":"Closing time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5}},"required":["open","close"]}}}}
```

## The MarketAssetDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketAssetDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Asset UUID identifier, global in scope of TSS","format":"uuid"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this asset","format":"uuid"},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of the asset","allOf":[{"$ref":"#/components/schemas/AssetType"}]},"name":{"type":"string","description":"Asset name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current asset supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total asset supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"isTradeable":{"type":"boolean","description":"Indicates if the asset can be traded"},"marketId":{"type":"string","description":"Market UUID identifier this asset was/is listed on","format":"uuid"}},"required":["createdAt","updatedAt","id","nodeId","issuingAccountAddress","operationalAccountAddress","type","name","specUrl","exponent","supply","totalSupply","ecbClassification","bolClassification","isTradeable","marketId"]},"AssetType":{"type":"string","enum":["currency","bond","equity","fund"],"description":"Type of the asset"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."}}}}
```

## The HaltStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"HaltStatus":{"type":"string","enum":["ended","started"],"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended"}}}}
```

## The AssetHaltDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AssetHaltDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Asset halt UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market id where the halt applies","format":"uuid"},"status":{"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended","allOf":[{"$ref":"#/components/schemas/HaltStatus"}]},"startedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was started"},"reason":{"type":"string","description":"Reason for the halt","minLength":1,"maxLength":512},"endedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was ended","nullable":true},"resumeReason":{"type":"string","description":"Reason for resuming trading","minLength":1,"maxLength":512,"nullable":true},"assetId":{"type":"string","description":"Asset id halt applies to","format":"uuid"}},"required":["createdAt","updatedAt","id","marketId","status","startedAt","reason","endedAt","resumeReason","assetId"]},"HaltStatus":{"type":"string","enum":["ended","started"],"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended"}}}}
```

## The FilterHaltDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterHaltDto":{"type":"object","properties":{"status":{"description":"Filter by halt status","allOf":[{"$ref":"#/components/schemas/HaltStatus"}]}}},"HaltStatus":{"type":"string","enum":["ended","started"],"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended"}}}}
```

## The ListingStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ListingStatus":{"type":"string","enum":["delisted","delisting-initiated","halted","listed","listing-cancelled","listing-initiated","listing-rejected"],"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator"}}}}
```

## The TickSizeStrategy object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"TickSizeStrategy":{"type":"string","enum":["static","tiered","volume-based"],"description":"Strategy used to resolve the effective tick size for the listing"}}}}
```

## The ListingDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ListingDto":{"type":"object","properties":{"id":{"type":"string","description":"Listing UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market UUID identifier this listing belongs to","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset Id","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset Id","format":"uuid"},"status":{"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator","allOf":[{"$ref":"#/components/schemas/ListingStatus"}]},"tickSizeStrategy":{"description":"Strategy used to resolve the effective tick size for the listing","allOf":[{"$ref":"#/components/schemas/TickSizeStrategy"}]},"tickSize":{"description":"Tick size the order prices must conform to.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/TickSize"}],"nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Timestamp when the listing was initiated"},"listedAt":{"format":"date-time","type":"string","description":"Timestamp when the asset pair was listed","nullable":true},"delistingInitiatedAt":{"format":"date-time","type":"string","description":"Timestamp when the delisting was initiated","nullable":true},"delistedAt":{"format":"date-time","type":"string","description":"Timestamp when the asset pair was delisted","nullable":true},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string","description":"Blockchain transaction hash that last updated this listing"}},"required":["id","marketId","baseAssetId","quoteAssetId","status","tickSizeStrategy","tickSize","initiatedAt","listedAt","delistingInitiatedAt","delistedAt","createdAt","updatedAt"]},"ListingStatus":{"type":"string","enum":["delisted","delisting-initiated","halted","listed","listing-cancelled","listing-initiated","listing-rejected"],"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator"},"TickSizeStrategy":{"type":"string","enum":["static","tiered","volume-based"],"description":"Strategy used to resolve the effective tick size for the listing"},"TickSize":{"allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}],"format":"int64","enum":[100,200,500,1000,2000,5000,10000,20000,50000,100000,200000,500000,1000000,2000000,5000000,10000000,20000000,50000000,100000000,200000000,500000000],"description":"Permitted tick sizes (MiFID II RTS 11). E.g. `100` = `0.0001`, `10000` = `0.01`, `1000000` = `1`, `500000000` = `500`.\n\nScaled as `ScaledDecimal`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The FilterListingDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterListingDto":{"type":"object","properties":{"id":{"description":"Filter by listing ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"baseAssetId":{"description":"Filter by base asset ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"quoteAssetId":{"description":"Filter by quote asset ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"status":{"description":"Filter by listing status(es)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/ListingStatus"},"minItems":1},{"$ref":"#/components/schemas/ListingStatus"}]},"initiatedAt":{"format":"date-time","description":"Filter listings initiated from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"listedAt":{"format":"date-time","description":"Filter listings listed from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"delistingInitiatedAt":{"format":"date-time","description":"Filter listings with delisting initiated from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"delistedAt":{"format":"date-time","description":"Filter delisted listings from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"ListingStatus":{"type":"string","enum":["delisted","delisting-initiated","halted","listed","listing-cancelled","listing-initiated","listing-rejected"],"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator"}}}}
```

## The FilterOrderDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterOrderDto":{"type":"object","properties":{"id":{"description":"Filter by order ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"accountAddress":{"description":"Filter by partial account address or list of account addresses","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"type":{"description":"Filter by order type(s)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/OrderType"},"minItems":1},{"$ref":"#/components/schemas/OrderType"}]},"side":{"description":"Filter by order side(s)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/OrderSide"},"minItems":1},{"$ref":"#/components/schemas/OrderSide"}]},"status":{"description":"Filter by order status(es)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/OrderStatus"},"minItems":1},{"$ref":"#/components/schemas/OrderStatus"}]},"placedAt":{"format":"date-time","description":"Filter orders placed from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"expiresAt":{"format":"date-time","description":"Filter orders expiring from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"OrderType":{"type":"string","enum":["limit","market"],"description":"Type of the order execution"},"OrderSide":{"type":"string","enum":["buy","sell"],"description":"Side of the order indicating buy or sell"},"OrderStatus":{"type":"string","enum":["open","filled","rejected","cancelled","expired"],"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled"}}}}
```

## The TradeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"TradeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Trade UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market identifier where the trade occurred","format":"uuid"},"listingId":{"type":"string","description":"Identifier of the market listing (trading pair)","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset identifier in the trading pair","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset identifier in the trading pair","format":"uuid"},"sellOrderId":{"type":"string","description":"UUID identifier of the sell order","format":"uuid"},"sellAccountAddress":{"type":"string","description":"Sell investor's account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"buyOrderId":{"type":"string","description":"UUID identifier of the buy order","format":"uuid"},"buyAccountAddress":{"type":"string","description":"Buy investor's account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of the base asset traded.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"price":{"format":"int64","description":"Price per unit of the base asset, denominated in the quote asset.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"totalPrice":{"format":"int64","description":"Actual total price of the trade.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"executedAt":{"format":"date-time","type":"string","description":"Timestamp when the trade was executed"},"executionOrder":{"type":"string","description":"Order in which the trade was executed"}},"required":["createdAt","updatedAt","id","marketId","listingId","baseAssetId","quoteAssetId","sellOrderId","sellAccountAddress","buyOrderId","buyAccountAddress","amount","price","totalPrice","executedAt","executionOrder"]},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The FilterTradeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterTradeDto":{"type":"object","properties":{"id":{"description":"Filter by trade ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"sellOrderId":{"description":"Filter by sell order ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"sellAccountAddress":{"description":"Filter by partial sell account address or a list of sell account addresses","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"buyOrderId":{"description":"Filter by buy order ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"buyAccountAddress":{"description":"Filter by partial buy account address or a list of buy account addresses","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"executedAt":{"format":"date-time","description":"Filter trades executed from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}}}}}
```

## The MarketHaltDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketHaltDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Market halt UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market id where the halt applies","format":"uuid"},"status":{"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended","allOf":[{"$ref":"#/components/schemas/HaltStatus"}]},"startedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was started"},"reason":{"type":"string","description":"Reason for the halt","minLength":1,"maxLength":512},"endedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was ended","nullable":true},"resumeReason":{"type":"string","description":"Reason for resuming trading","minLength":1,"maxLength":512,"nullable":true}},"required":["createdAt","updatedAt","id","marketId","status","startedAt","reason","endedAt","resumeReason"]},"HaltStatus":{"type":"string","enum":["ended","started"],"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended"}}}}
```

## The ParticipantDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ParticipantDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"email":{"type":"string","description":"Email of a participant","format":"email","nullable":true},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"representorCompanyCode":{"type":"string","description":"Company registration number of participant representor","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$","nullable":true},"countryCode":{"type":"string","description":"Country code of the participant","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Country code of the branch","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"type":"string","description":"Bank Identifier Code (BIC)","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"isLiquidityProvider":{"type":"boolean","description":"Is participant a liquidity provider in the market","default":false}},"required":["createdAt","updatedAt","name","email","leiCode","companyCode","representorCompanyCode","countryCode","branchCountryCode","institutionSectorCode","bic","isLiquidityProvider"]},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The OperatorDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OperatorDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"email":{"type":"string","description":"Email of a participant","format":"email","nullable":true},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"representorCompanyCode":{"type":"string","description":"Company registration number of participant representor","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$","nullable":true},"countryCode":{"type":"string","description":"Country code of the participant","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Country code of the branch","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"type":"string","description":"Bank Identifier Code (BIC)","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"isLiquidityProvider":{"type":"boolean","description":"Is participant a liquidity provider in the market","default":false},"id":{"type":"string","description":"Id of an Operator"},"accountAddress":{"type":"string","description":"Operators operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"onlinePublicKey":{"type":"string","description":"Public key of the operator's node signer","format":"xrp-public-key","minLength":66,"maxLength":66,"pattern":"^(02|03|ED)[0-9A-Fa-f]{64}$"},"offlinePublicKey":{"type":"string","description":"Public key of the operator's offline node signer","format":"xrp-public-key","minLength":66,"maxLength":66,"pattern":"^(02|03|ED)[0-9A-Fa-f]{64}$"}},"required":["createdAt","updatedAt","name","email","leiCode","companyCode","representorCompanyCode","countryCode","branchCountryCode","institutionSectorCode","bic","isLiquidityProvider","id","accountAddress","onlinePublicKey","offlinePublicKey"]},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The InitiateOtcTradeDvpDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InitiateOtcTradeDvpDto":{"type":"object","properties":{"initiatorAccountAddress":{"type":"string","description":"Initiator account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"initiatorSendAssetId":{"type":"string","description":"Initiator sending asset id","format":"uuid"},"initiatorSendAmount":{"format":"int64","description":"Initiator sending asset amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"acceptorAccountAddress":{"type":"string","description":"Accepter account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"acceptorSendAssetId":{"type":"string","description":"Acceptor sending asset id","format":"uuid"},"acceptorSendAmount":{"format":"int64","description":"Acceptor sending asset amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"tradedAt":{"format":"date-time","type":"string","description":"Trade day in ISO 8601 format YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ"}},"required":["initiatorAccountAddress","initiatorSendAssetId","initiatorSendAmount","acceptorAccountAddress","acceptorSendAssetId","acceptorSendAmount","tradedAt"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The UpdateOtcTradeDvpDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateOtcTradeDvpDto":{"type":"object","properties":{"status":{"description":"**Update OTC DVP trade status:**\n- `completed` - (destination investor agent) complete OTC DVP trade\n- `cancelled` - (source investor agent) cancel OTC DVP trade\n- `rejected` - (destination investor agent) reject OTC DVP trade","allOf":[{"$ref":"#/components/schemas/OtcTradeDvpStatus"}]}},"required":["status"]},"OtcTradeDvpStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"}}}}
```

## The FilterOtcTradeDvpDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterOtcTradeDvpDto":{"type":"object","properties":{"status":{"description":"Filter OTC Trades DVP by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/OtcTradeDvpStatus"},"minItems":1},{"$ref":"#/components/schemas/OtcTradeDvpStatus"}]},"initiatorAccountAddress":{"description":"Filter OTC Trades DVP by initiator address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"initiatorSendAssetId":{"description":"Filter OTC Trades DVP by initiator send asset id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"initiatorBrokerId":{"description":"Filter OTC Trades DVP by initiator broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"acceptorAccountAddress":{"description":"Filter OTC Trades DVP by acceptor account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"acceptorSendAssetId":{"description":"Filter OTC Trades DVP by acceptor send asset id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"acceptorBrokerId":{"description":"Filter OTC Trades DVP by acceptor broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]}}},"OtcTradeDvpStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"}}}}
```

## The InitiateOtcTradeFopDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InitiateOtcTradeFopDto":{"type":"object","properties":{"initiatorAccountAddress":{"type":"string","description":"Initiator account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"assetId":{"type":"string","description":"Initiator sending asset id","format":"uuid"},"amount":{"format":"int64","description":"Initiator sending asset amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"acceptorAccountAddress":{"type":"string","description":"Accepter account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"reason":{"description":"**Reason for initiating OTC FOP trade:**\n- `error` - initiate error correcting trade\n- `restriction` - initiate trade due to restriction\n\n_*Required for currency transactions*_","allOf":[{"$ref":"#/components/schemas/OtcReason"}]},"tradedAt":{"format":"date-time","type":"string","description":"Trade day in ISO 8601 format YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ"}},"required":["initiatorAccountAddress","assetId","amount","acceptorAccountAddress","tradedAt"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"OtcReason":{"type":"string","enum":["internal","external","restriction","error","client-instruction"],"description":"Reason for the trade"}}}}
```

## The UpdateOtcTradeFopDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateOtcTradeFopDto":{"type":"object","properties":{"status":{"description":"**OTC Trade FOP status:**\n- `completed` - (destination investor agent) complete `initiated` OTC FOP trade\n- `cancelled` - (source investor agent) cancel `initiated` OTC FOP trade\n- `rejected` - (destination investor agent) reject `initiated` OTC FOP trade","allOf":[{"$ref":"#/components/schemas/OtcTradeFopStatus"}]}},"required":["status"]},"OtcTradeFopStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"}}}}
```

## The FilterOtcTradeFopDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterOtcTradeFopDto":{"type":"object","properties":{"assetId":{"description":"Filter OTC Trades FOP by asset id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"status":{"description":"Filter OTC Trades FOP by status","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/OtcTradeFopStatus"},"minItems":1},{"$ref":"#/components/schemas/OtcTradeFopStatus"}]},"initiatorAccountAddress":{"description":"Filter OTC Trades FOP by initiator account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"initiatorBrokerId":{"description":"Filter OTC Trades FOP by initiator broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"acceptorAccountAddress":{"description":"Filter OTC Trades FOP by acceptor account address","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"acceptorBrokerId":{"description":"Filter OTC Trades FOP by acceptor broker id","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]}}},"OtcTradeFopStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"}}}}
```

## The OwnershipChangeStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OwnershipChangeStatus":{"type":"string","enum":["created","accepted","cancelled","expired"],"description":"Status of an ownership change"}}}}
```

## The OwnershipChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OwnershipChangeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Ownership Change UUID identifier, unique in scope of this node","format":"uuid"},"assetId":{"type":"string","description":"Identifier of an asset, unique for this gateway","format":"uuid"},"amount":{"format":"int64","description":"Amount of assets to transfer ownership of.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"sourceAccountAddress":{"type":"string","description":"Account address who is sending an asset, unique for this gateway","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"destinationAccountAddress":{"type":"string","description":"Account address who is receiving an asset, unique for this gateway","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"status":{"description":"Status of an ownership change","allOf":[{"$ref":"#/components/schemas/OwnershipChangeStatus"}]},"description":{"type":"object","description":"Reason for why the transfer was initiated in the first place"},"message":{"type":"object","description":"Optional message provided when accepting/canceling ownership changes"},"cancelledByAccountAddress":{"type":"string","description":"Account address which cancelled the ownership change","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"expiresAt":{"type":"object","description":"Timestamp until when this ownership can be accepted or cancelled"}},"required":["createdAt","updatedAt","id","assetId","amount","sourceAccountAddress","destinationAccountAddress","status"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"OwnershipChangeStatus":{"type":"string","enum":["created","accepted","cancelled","expired"],"description":"Status of an ownership change"}}}}
```

## The CreateOwnershipChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateOwnershipChangeDto":{"type":"object","properties":{"assetId":{"type":"string","description":"Asset identifier to be transferred ,unique to this gateway","format":"uuid"},"sourceAccountAddress":{"type":"string","description":"Source account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"destinationAccountAddress":{"type":"string","description":"Destination account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of tokens to transfer ownership of.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"description":{"type":"string","description":"Optional description of why this transfer was initiated"},"expiresAt":{"format":"date-time","type":"string","description":"Timestamp in the future when this transfer proposal will be available"}},"required":["assetId","sourceAccountAddress","destinationAccountAddress","amount"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The UpdateOwnershipChangeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"UpdateOwnershipChangeDto":{"type":"object","properties":{"status":{"description":"Status to change ownership change to","allOf":[{"$ref":"#/components/schemas/OwnershipChangeStatus"}]},"accountAddress":{"type":"string","description":"Address of a sender or receiver account, on whose behalf this change action is performed. (Receiver address for accepting)","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"message":{"type":"string","description":"An optional message that will be attached to ownership change on cancellation"}},"required":["status","accountAddress"]},"OwnershipChangeStatus":{"type":"string","enum":["created","accepted","cancelled","expired"],"description":"Status of an ownership change"}}}}
```

## The SecurityType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SecurityType":{"type":"string","enum":["bond","equity","fund"],"description":"Type of the security"}}}}
```

## The SecurityDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SecurityDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Security UUID identifier - global in scope of TSS","format":"uuid"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this security","format":"uuid"},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of the security","allOf":[{"$ref":"#/components/schemas/SecurityType"}]},"issuerId":{"type":"string","description":"Issuer UUID identifier for bond, fund and equity securities","format":"uuid"},"isin":{"type":"string","nullable":true,"description":"ISIN for bond, fund and equity securities"},"currencyId":{"type":"string","description":"Currency UUID identifier for bond, fund and equity securities","format":"uuid"},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"name":{"type":"string","description":"Security name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current security supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total security supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"isTradeable":{"type":"boolean","description":"Indicates if the security can be traded"}},"required":["createdAt","updatedAt","id","nodeId","issuingAccountAddress","operationalAccountAddress","type","issuerId","isin","currencyId","ecbClassification","bolClassification","name","specUrl","exponent","supply","totalSupply","isTradeable"]},"SecurityType":{"type":"string","enum":["bond","equity","fund"],"description":"Type of the security"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The FilterSecurityDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterSecurityDto":{"type":"object","properties":{"id":{"description":"Filter by security ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"nodeId":{"description":"Filter by node ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuerId":{"description":"Filter by issuer ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"issuingAccountAddress":{"description":"Filter by issuing account's address(es)","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"operationalAccountAddress":{"description":"Filter by operational account's address(es)","oneOf":[{"type":"array","items":{"description":"Account address","type":"string","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"minItems":1},{"type":"string","description":"Partial account address"}]},"name":{"description":"Filter by security name(s)","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1},{"type":"string","description":"Partial security name"}]},"isin":{"type":"string","description":"Filter bonds by ISIN"},"type":{"description":"Filter by security type(s)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/SecurityType"},"minItems":1},{"$ref":"#/components/schemas/SecurityType"}]},"createdAt":{"format":"date-time","description":"Filter securities created from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]},"totalSupply":{"description":"Filter securities by total supply from number or between two numbers","oneOf":[{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1,"maxItems":2},{"type":"integer","format":"int64"}]}}},"SecurityType":{"type":"string","enum":["bond","equity","fund"],"description":"Type of the security"}}}}
```

## The OrderMatchDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OrderMatchDto":{"type":"object","properties":{"created_at":{"format":"date-time","type":"string","description":"Created date"},"updated_at":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Order match UUID identifier, unique in scope of this node","format":"uuid"},"order_id_1":{"type":"string","description":"Unique identifier for the first order in the match in scope of this gateway","format":"uuid"},"order_id_2":{"type":"string","description":"Unique identifier for the second order in the match in scope of this gateway","format":"uuid"},"buy_amount_1":{"type":"number","description":"Buy amount of the first order in the match"},"buy_amount_2":{"type":"number","description":"Buy amount of the second order in the match"},"match_ratio":{"type":"number","description":"Ratio of the match/price"}},"required":["created_at","updated_at","id","order_id_1","order_id_2","buy_amount_1","buy_amount_2","match_ratio"]}}}}
```

## The EncodedDescriptionWithCorrelationIdDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EncodedDescriptionWithCorrelationIdDto":{"type":"object","properties":{"description":{"type":"string","description":"Encoded payment description"},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["description","correlationId"]}}}}
```

## The PlainDescriptionDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PlainDescriptionDto":{"type":"object","properties":{"address":{"type":"string","description":"Source or destination address on the blockchain","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["address","correlationId"]}}}}
```

## The EventType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"}}}}
```

## The AccountEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AccountEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the account event","allOf":[{"$ref":"#/components/schemas/AccountDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"AccountDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of account","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","type":"string","description":"Opened date"}},"required":["createdAt","updatedAt","nodeId","address","type","institutionSectorCode","walletType","status","openedAt"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"}}}}
```

## The BidEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BidEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the auction bid event","allOf":[{"$ref":"#/components/schemas/BidDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"BidDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bid UUID identifier, unique in scope of this node","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID that placed the bid","format":"uuid"},"assetId":{"type":"string","description":"Asset UUID that the bid is for","format":"uuid"},"auctionId":{"type":"string","description":"Auction UUID that the bid is for","format":"uuid"},"accountAddress":{"type":"string","description":"Account address that placed the bid","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"status":{"description":"Auction bid status","allOf":[{"$ref":"#/components/schemas/BidStatus"}]},"amount":{"format":"int64","description":"Bond amount the bid is for.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"price":{"format":"int64","description":"Bond price per unit.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalPrice":{"format":"int64","description":"Total bid price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"placedAt":{"format":"date-time","type":"string","description":"Bid placement time","nullable":true},"settledAmount":{"nullable":true,"description":"Settled amount the bid is for.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledTotalPrice":{"nullable":true,"description":"Settled total price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledAt":{"format":"date-time","type":"string","description":"Bid settlement time","nullable":true}},"required":["createdAt","updatedAt","id","brokerId","assetId","auctionId","accountAddress","status","amount","price","totalPrice","placedAt","settledAmount","settledTotalPrice","settledAt"]},"BidStatus":{"type":"string","enum":["placed","funded","matched","settled","not-matched","rejected","cancelled"],"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The AuctionEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"AuctionEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the auction event","allOf":[{"$ref":"#/components/schemas/AuctionDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"AuctionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Auction UUID identifier, unique in scope of this node","format":"uuid"},"brokerId":{"type":"string","description":"Broker id","format":"uuid"},"assetId":{"type":"string","description":"Asset id","format":"uuid"},"type":{"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive","allOf":[{"$ref":"#/components/schemas/AuctionType"}]},"status":{"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent","allOf":[{"$ref":"#/components/schemas/AuctionStatus"}]},"minAmount":{"format":"int64","description":"Minimal amount that needs to be auctioned off for the auction to succeed.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"price":{"format":"int64","description":"Minimal or fixed price, determined by auction type.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"startAt":{"format":"date-time","type":"string","description":"Date and time of auction opening"},"endAt":{"format":"date-time","type":"string","description":"Date and time of auction closing"},"settledAmount":{"nullable":true,"description":"Total settled amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledTotalPrice":{"nullable":true,"description":"Settled total price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledAt":{"format":"date-time","type":"string","description":"Date and time of auction settlement","nullable":true}},"required":["createdAt","updatedAt","id","brokerId","assetId","type","status","minAmount","price","startAt","endAt","settledAmount","settledTotalPrice","settledAt"]},"AuctionType":{"type":"string","enum":["fixed-price","min-price"],"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive"},"AuctionStatus":{"type":"string","enum":["upcoming","open","closed","settled","failed","cancelled"],"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The CouponEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CouponEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the bond coupon event","allOf":[{"$ref":"#/components/schemas/CouponDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"CouponDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Coupon UUID identifier, global in scope of TSS","format":"uuid"},"no":{"type":"number","description":"Coupon №"},"bondId":{"type":"string","description":"Bond UUID, unique in scope of this node","format":"uuid"},"status":{"description":"Coupon status","allOf":[{"$ref":"#/components/schemas/CouponStatus"}]},"totalPayment":{"format":"int64","description":"Total payment of coupon, in the bond currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"nullable":true,"description":"Annual interest rate applicable to this coupon period. Null when not yet set.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"recordAt":{"format":"date-time","type":"string","description":"Date of coupon's period end, bond holders are recorded."},"payAt":{"format":"date-time","type":"string","description":"Date of coupon's payment, must be later than record date."}},"required":["createdAt","updatedAt","id","no","bondId","status","totalPayment","interestRate","recordAt","payAt"]},"CouponStatus":{"type":"string","enum":["paid","readyToPay","upcoming","paying","noFunds"],"description":"Coupon status"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The DistributionFopEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DistributionFopEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the bond distribution fop event","allOf":[{"$ref":"#/components/schemas/DistributionFopDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"DistributionFopDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Distribution FOP UUID identifier, unique in scope of this node","format":"uuid"},"distributionId":{"type":"string","description":"Distribution id","format":"uuid"},"assetId":{"type":"string","description":"Asset id","format":"uuid"},"accountAddress":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount to receive.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status","allOf":[{"$ref":"#/components/schemas/DistributionFopStatus"}]},"settledAt":{"format":"date-time","type":"string","description":"Date and time of distribution FOP"}},"required":["createdAt","updatedAt","id","distributionId","assetId","accountAddress","amount","status","settledAt"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"DistributionFopStatus":{"type":"string","enum":["upcoming","initiated","initiation-failed","completed","completion-failed"],"description":"**Update distribution FOP status**\n- `initiated` - (issuer agent) initiate `upcoming` or `initiation-failed` FOP distribution\n- `completed` - (investor agent) complete `initiated` FOP distribution"}}}}
```

## The MaturityPaymentEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MaturityPaymentEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the bond maturity payment event","allOf":[{"$ref":"#/components/schemas/MaturityPaymentDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"MaturityPaymentDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Maturity Payment UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the maturity payment","allOf":[{"$ref":"#/components/schemas/MaturityPaymentStatus"}]},"bondId":{"type":"string","description":"Unique UUID of the bond in scope of this gateway","format":"uuid"},"bondAmount":{"format":"int64","description":"Bond amount for this maturity payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"payoutAmount":{"format":"int64","description":"Amount to pay for this maturity payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"receiverAddress":{"type":"string","description":"Payment`s receiver address corresponding to the investor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"errorMessage":{"type":"string","description":"Error message"}},"required":["createdAt","updatedAt","id","status","bondId","bondAmount","payoutAmount","receiverAddress"]},"MaturityPaymentStatus":{"type":"string","enum":["recorded","no-funds","initiated","initiation-failed","completed","completion-failed"],"description":"Status of the maturity payment"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The BondEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BondEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the bond event","allOf":[{"$ref":"#/components/schemas/BondDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"BondDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bond UUID identifier, global in scope of TSS","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the currency that payouts of the bond are made with in scope of this gateway","format":"uuid"},"brokerId":{"type":"string","description":"Unique UUID of the broker that manages this bond issue","format":"uuid"},"origin":{"description":"Origin of the bond","allOf":[{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Custodian where asset is registered outside","nullable":true},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","nullable":true},"issuerCsdLeiCode":{"type":"string","description":"LEI code of central securities depository where the issuer has registered the securities","nullable":true},"csdRegisteredAt":{"type":"string","description":"Date of registration in central depository","format":"date-time","nullable":true},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code","nullable":true},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35,"nullable":true},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"turnoverType":{"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred","nullable":true,"allOf":[{"$ref":"#/components/schemas/TurnoverType"}]},"seniority":{"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation","allOf":[{"$ref":"#/components/schemas/BondSeniority"}]},"status":{"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)","allOf":[{"$ref":"#/components/schemas/BondStatus"}]},"initialPlacement":{"description":"Initial placement type","default":"public","allOf":[{"$ref":"#/components/schemas/InitialPlacementType"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isin":{"type":"string","description":" International Securities Identification Number. Code that uniquely identifies a security globally","nullable":true},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$","nullable":true},"figi":{"type":"string","description":"Financial Instrument Global Identifier. Code that uniquely identifies a security globally","nullable":true},"ticker":{"type":"string","description":"Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes","nullable":true},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"issuePrice":{"type":"string","description":"Price of the bond issue"},"nominalValue":{"format":"int64","description":"Nominal value of a single bond unit, also known as face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalNominalValue":{"format":"int64","description":"Nominal value of a full bond issue, also known as total face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"type":"string","description":"Annual interest rate in % paid for holding this bond"},"interestType":{"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference","allOf":[{"$ref":"#/components/schemas/InterestType"}]},"interestBase":{"description":"Interest calculation option","allOf":[{"$ref":"#/components/schemas/InterestBaseOptions"}]},"interestInterval":{"description":"Interest payment interval","allOf":[{"$ref":"#/components/schemas/InterestIntervalOptions"}]},"settlementUnitMultiple":{"type":"string","description":"Settlement unit multiple expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"minimumSettlementUnit":{"type":"string","description":"Minimum settlement unit expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the bond prospectus registered"},"preEmptiveRights":{"type":"boolean","description":"Indicator, if the bond has pre-emptive rights"},"earlyRedemption":{"type":"boolean","description":"Indicator, if the bond can be redeemed early"},"secured":{"type":"boolean","description":"Indicator, if the bond is secured"},"securedBacking":{"type":"string","description":"Backing of the secured bond","nullable":true},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the bond."},"issuanceRecordAt":{"format":"date-time","type":"string","description":"Bond issue record date, from which the coupon accumulation starts."},"settleAt":{"format":"date-time","type":"string","description":"Date when the bond was or is expected to be fully distributed among initial holders."},"maturityRecordAt":{"format":"date-time","type":"string","description":"Date when the bond reaches maturity and final owners are fixed."},"matureAt":{"format":"date-time","type":"string","description":"Date when the bond maturity is expected to be paid out."},"distributedAmount":{"format":"int64","description":"Amount of bonds that have been proposed to distribute to investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestedAmount":{"format":"int64","description":"Amount of mature bonds requested to collect from investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"collectedAmount":{"format":"int64","description":"Amount of mature bonds collected back.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"name":{"type":"string","description":"Bond name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current bond supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total bond supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"couponIds":{"description":"Coupon ids","type":"array","items":{"type":"string"}},"maturityPaymentIds":{"description":"Maturity payment ids","type":"array","items":{"type":"string"}},"distributionIds":{"description":"Distribution ids","type":"array","items":{"type":"string"}},"settlementType":{"description":"**Corporate actions settlement type:**\n- `internal` - payments (coupons, maturity) are settled within Axiology TSS using EMTs\n- `external` - payments are settled via bank or other payment systems outside Axiology TSS","allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"displayNotation":{"description":"Display hint only. The bond's monetary fields are returned as scaled monetary amounts regardless of this value; consumers use it to decide whether to render values as a percentage of nominal or as a per-unit amount.","allOf":[{"$ref":"#/components/schemas/PriceNotation"}]}},"required":["createdAt","updatedAt","id","issuerId","currencyId","brokerId","origin","custodian","custodianLeiCode","issuerCsdLeiCode","csdRegisteredAt","underlyingInstrumentCode","fisn","countryCode","turnoverType","seniority","status","initialPlacement","issuingAccountAddress","operationalAccountAddress","isin","cfi","figi","ticker","dti","ecbClassification","bolClassification","issuePrice","nominalValue","totalNominalValue","interestRate","interestType","interestBase","interestInterval","settlementUnitMultiple","minimumSettlementUnit","prospectusRegistered","preEmptiveRights","earlyRedemption","secured","securedBacking","issuedAt","issuanceRecordAt","settleAt","maturityRecordAt","matureAt","distributedAmount","requestedAmount","collectedAmount","name","specUrl","exponent","supply","totalSupply","couponIds","maturityPaymentIds","distributionIds","settlementType","displayNotation"]},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"BondStatus":{"type":"string","enum":["draft","recorded","issued","distributing","live","locked","mature","collecting","collected","closed"],"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"},"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"},"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."}}}}
```

## The BrokerEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"BrokerEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the broker event","allOf":[{"$ref":"#/components/schemas/BrokerDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"BrokerDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"email":{"type":"string","description":"Email of a participant","format":"email","nullable":true},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"representorCompanyCode":{"type":"string","description":"Company registration number of participant representor","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$","nullable":true},"countryCode":{"type":"string","description":"Country code of the participant","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Country code of the branch","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"type":"string","description":"Bank Identifier Code (BIC)","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"isLiquidityProvider":{"type":"boolean","description":"Is participant a liquidity provider in the market","default":false},"id":{"type":"string","description":"Broker UUID identifier, global in scope of TSS","format":"uuid"},"ibans":{"description":"List of IBANs used for deposits and withdrawals","type":"array","items":{"$ref":"#/components/schemas/TypedIban"}}},"required":["createdAt","updatedAt","name","email","leiCode","companyCode","representorCompanyCode","countryCode","branchCountryCode","institutionSectorCode","bic","isLiquidityProvider","id","ibans"]},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"TypedIban":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN of the wallet","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"type":{"description":"Type of the wallet","allOf":[{"$ref":"#/components/schemas/WalletType"}]}},"required":["iban","type"]},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"}}}}
```

## The DepositEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DepositEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the currency deposit event","allOf":[{"$ref":"#/components/schemas/DepositDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"DepositDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Deposit UUID identifier, global in scope of TSS","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID identifier","format":"uuid"},"currencyId":{"type":"string","description":"Currency UUID identifier","format":"uuid"},"accountAddress":{"type":"string","description":"Destination account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"iban":{"type":"string","description":"Source IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"amount":{"format":"int64","description":"Deposit amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status of deposit","allOf":[{"$ref":"#/components/schemas/DepositStatus"}]},"transactionId":{"type":"string","description":"SEPA payment's Transaction Id","format":"iso-20022-payment-tx-id","minLength":10,"maxLength":35},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["createdAt","updatedAt","id","brokerId","currencyId","accountAddress","iban","amount","status","transactionId","correlationId"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"DepositStatus":{"type":"string","enum":["approved","deposited","initiated","rejected"],"description":"Status of deposit"}}}}
```

## The WithdrawalEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"WithdrawalEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the currency withdrawal event","allOf":[{"$ref":"#/components/schemas/WithdrawalDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"WithdrawalDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Withdrawal UUID identifier, global in scope of TSS","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID identifier","format":"uuid"},"currencyId":{"type":"string","description":"Currency UUID identifier","format":"uuid"},"accountAddress":{"type":"string","description":"Source account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"iban":{"type":"string","description":"Destination IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"amount":{"format":"int64","description":"Withdrawal amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status of withdrawal","allOf":[{"$ref":"#/components/schemas/WithdrawalStatus"}]},"transactionId":{"type":"string","description":"SEPA payment's Transaction Id","format":"iso-20022-payment-tx-id","minLength":10,"maxLength":35,"nullable":true},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["createdAt","updatedAt","id","brokerId","currencyId","accountAddress","iban","amount","status","transactionId","correlationId"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"WithdrawalStatus":{"type":"string","enum":["failed","initiated","rejected","returned","started","withdrawn"],"description":"Status of withdrawal"}}}}
```

## The CurrencyEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CurrencyEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the currency event","allOf":[{"$ref":"#/components/schemas/CurrencyDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"CurrencyDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Currency UUID identifier, global in scope of TSS","format":"uuid"},"name":{"type":"string","description":"Full name of the currency"},"code":{"type":"string","description":"Unique code of the currency"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supplyLimit":{"format":"int64","description":"Maximum amount of currency allowed in circulation.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"}},"required":["createdAt","updatedAt","id","name","code","exponent","supplyLimit","issuingAccountAddress","operationalAccountAddress"]},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The DataValidationEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DataValidationEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the data validation event","allOf":[{"$ref":"#/components/schemas/DataValidationDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"DataValidationDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Data validation UUID identifier, global in scope of TSS","format":"uuid"},"assetId":{"type":"string","description":"Unique UUID of the asset in scope of this gateway","format":"uuid"},"status":{"allOf":[{"$ref":"#/components/schemas/DataValidationStatus"}]},"specUrl":{"type":"string","description":"IPFS link with data that was validated or needs to be validated"},"initiationReference":{"type":"string","description":"Reference provided by the broker during data validation initiation"},"validationReference":{"type":"string","description":"Reference provided by the operator during data validation","nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Date when the data validation was initiated"},"validatedAt":{"type":"string","description":"Date when the data validation was completed","format":"date-time","nullable":true}},"required":["createdAt","updatedAt","id","assetId","status","specUrl","initiationReference","validationReference","initiatedAt","validatedAt"]},"DataValidationStatus":{"type":"string","enum":["approved","cancelled","initiated","rejected"],"description":"**Data validation status:**\n- `initiated` - data validation has been requested and is awaiting operator review\n- `approved` - operator approved the data validation\n- `rejected` - operator rejected the data validation\n- `cancelled` - data validation was cancelled by the broker"}}}}
```

## The SubscriptionEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SubscriptionEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the fund subscription event","allOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"SubscriptionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund subscription UUID identifier, global in scope of TSS","format":"uuid"},"fundId":{"type":"string","description":"Fund (asset) id the subscription is for","format":"uuid"},"investorBrokerId":{"type":"string","description":"Broker id of the investor's agent","format":"uuid"},"issuerBrokerId":{"type":"string","description":"Broker id of the fund issuer","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Lifecycle status of the subscription","allOf":[{"$ref":"#/components/schemas/SubscriptionStatus"}]},"totalPrice":{"nullable":true,"description":"Requested or settled price, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"nullable":true,"description":"Requested or settled amount, in fund units\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestReference":{"type":"string","description":"Reference provided when the subscription was requested","maxLength":256,"nullable":true},"resolutionReference":{"type":"string","description":"Reference provided when the subscription was settled, rejected or cancelled","maxLength":256,"nullable":true}},"required":["createdAt","updatedAt","id","fundId","investorBrokerId","issuerBrokerId","accountAddress","cashLegType","status","totalPrice","amount","requestReference","resolutionReference"]},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"SubscriptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund subscription status:**\n- `requested` - subscription requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; units delivered to the investor"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The RedemptionEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"RedemptionEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the fund redemption event","allOf":[{"$ref":"#/components/schemas/RedemptionDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"RedemptionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund redemption UUID identifier, global in scope of TSS","format":"uuid"},"fundId":{"type":"string","description":"Fund (asset) id the redemption is for","format":"uuid"},"investorBrokerId":{"type":"string","description":"Broker id of the investor's agent","format":"uuid"},"issuerBrokerId":{"type":"string","description":"Broker id of the fund issuer","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Lifecycle status of the redemption","allOf":[{"$ref":"#/components/schemas/RedemptionStatus"}]},"totalPrice":{"nullable":true,"description":"Settled cash proceeds, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"format":"int64","description":"Amount of fund units to redeem\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestReference":{"type":"string","description":"Reference provided when the redemption was requested","maxLength":256,"nullable":true},"resolutionReference":{"type":"string","description":"Reference provided when the redemption was settled, rejected or cancelled","maxLength":256,"nullable":true}},"required":["createdAt","updatedAt","id","fundId","investorBrokerId","issuerBrokerId","accountAddress","cashLegType","status","totalPrice","amount","requestReference","resolutionReference"]},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"RedemptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund redemption status:**\n- `requested` - redemption requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; cash delivered to the investor"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The IssuerEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"IssuerEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the issuer event","allOf":[{"$ref":"#/components/schemas/IssuerDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"IssuerDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Issuer UUID identifier, unique in scope of this node","format":"uuid"},"type":{"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer","allOf":[{"$ref":"#/components/schemas/IssuerType"}]},"accountAddress":{"type":"string","description":"Issuer account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"address":{"type":"string","description":"Address of headquarters"},"postalAddress":{"type":"string","description":"Address of headquarters"},"countryCode":{"type":"string","description":"Country code of where the issuing company is located","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"leiCode":{"type":"string","description":"Unique identifier of the company/institution issuing the asset (LEI - Legal Entity Identifier)","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"vatCode":{"type":"string","description":"Value-added tax identification number","format":"vat-code","nullable":true},"email":{"type":"string","description":"Email of the issuing company’s representative","format":"email","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"ratingAgency":{"type":"string","nullable":true},"rating":{"type":"string","nullable":true}},"required":["createdAt","updatedAt","id","type","accountAddress","name","companyCode","address","postalAddress","countryCode","leiCode","vatCode","email","institutionSectorCode","ratingAgency","rating"]},"IssuerType":{"type":"string","enum":["bank","government","investment-holding-company","other","plc","pllc","small-pllc","sole-proprietorship"],"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."}}}}
```

## The MarketAssetEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketAssetEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the asset event in the market","allOf":[{"$ref":"#/components/schemas/MarketAssetDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"MarketAssetDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Asset UUID identifier, global in scope of TSS","format":"uuid"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this asset","format":"uuid"},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of the asset","allOf":[{"$ref":"#/components/schemas/AssetType"}]},"name":{"type":"string","description":"Asset name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current asset supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total asset supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"isTradeable":{"type":"boolean","description":"Indicates if the asset can be traded"},"marketId":{"type":"string","description":"Market UUID identifier this asset was/is listed on","format":"uuid"}},"required":["createdAt","updatedAt","id","nodeId","issuingAccountAddress","operationalAccountAddress","type","name","specUrl","exponent","supply","totalSupply","ecbClassification","bolClassification","isTradeable","marketId"]},"AssetType":{"type":"string","enum":["currency","bond","equity","fund"],"description":"Type of the asset"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."}}}}
```

## The MarketHaltEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketHaltEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the market halt event","allOf":[{"$ref":"#/components/schemas/MarketHaltDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"MarketHaltDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Market halt UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market id where the halt applies","format":"uuid"},"status":{"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended","allOf":[{"$ref":"#/components/schemas/HaltStatus"}]},"startedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was started"},"reason":{"type":"string","description":"Reason for the halt","minLength":1,"maxLength":512},"endedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was ended","nullable":true},"resumeReason":{"type":"string","description":"Reason for resuming trading","minLength":1,"maxLength":512,"nullable":true}},"required":["createdAt","updatedAt","id","marketId","status","startedAt","reason","endedAt","resumeReason"]},"HaltStatus":{"type":"string","enum":["ended","started"],"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended"}}}}
```

## The OrderEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OrderEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the market listing order event","allOf":[{"$ref":"#/components/schemas/OrderDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"OrderDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Order UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market identifier where the order is placed","format":"uuid"},"listingId":{"type":"string","description":"Identifier of the market listing (trading pair)","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset identifier in the trading pair","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset identifier in the trading pair","format":"uuid"},"accountAddress":{"type":"string","description":"Investment account address that placed the order","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"**Order execution strategy:**\n- `limit`: Executes at a specified price or better\n- `market`: Executes immediately at the best available price","allOf":[{"$ref":"#/components/schemas/OrderType"}]},"side":{"description":"**Side of the order indicating intent to buy or sell.**\n- `buy`: Order to purchase the base asset using the quote asset\n- `sell`: Order to sell the base asset in exchange for the quote asset","allOf":[{"$ref":"#/components/schemas/OrderSide"}]},"status":{"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled","allOf":[{"$ref":"#/components/schemas/OrderStatus"}]},"amount":{"format":"int64","description":"Amount of the base asset to trade.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"filledAmount":{"format":"int64","description":"Amount of the base asset that is filled.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"price":{"format":"int64","description":"Price per unit of the base asset, denominated in the quote asset.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"placedAt":{"format":"date-time","type":"string","description":"Placement date of the order"},"cancelledAt":{"format":"date-time","type":"string","description":"Cancellation date of the order","nullable":true},"cancelledReason":{"description":"**Order cancelled reason:**\n- `broker`: Order is cancelled by broker\n- `listing-delisted`: Order is cancelled by system because of delisted listing","nullable":true,"allOf":[{"$ref":"#/components/schemas/OrderCancelledReason"}]},"expiresAt":{"format":"date-time","type":"string","description":"Expiration date of the order","nullable":true}},"required":["createdAt","updatedAt","id","marketId","listingId","baseAssetId","quoteAssetId","accountAddress","type","side","status","amount","filledAmount","price","placedAt","cancelledAt","cancelledReason","expiresAt"]},"OrderType":{"type":"string","enum":["limit","market"],"description":"Type of the order execution"},"OrderSide":{"type":"string","enum":["buy","sell"],"description":"Side of the order indicating buy or sell"},"OrderStatus":{"type":"string","enum":["open","filled","rejected","cancelled","expired"],"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled"},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"OrderCancelledReason":{"type":"string","enum":["broker","listing-delisted","bond-locked"],"description":"**Order cancelled reason:**\n- `broker`: Order is cancelled by broker\n- `listing-delisted`: Order is cancelled by system because of delisted listing"}}}}
```

## The TradeEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"TradeEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the market listing trade event","allOf":[{"$ref":"#/components/schemas/TradeDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"TradeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Trade UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market identifier where the trade occurred","format":"uuid"},"listingId":{"type":"string","description":"Identifier of the market listing (trading pair)","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset identifier in the trading pair","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset identifier in the trading pair","format":"uuid"},"sellOrderId":{"type":"string","description":"UUID identifier of the sell order","format":"uuid"},"sellAccountAddress":{"type":"string","description":"Sell investor's account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"buyOrderId":{"type":"string","description":"UUID identifier of the buy order","format":"uuid"},"buyAccountAddress":{"type":"string","description":"Buy investor's account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of the base asset traded.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"price":{"format":"int64","description":"Price per unit of the base asset, denominated in the quote asset.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"totalPrice":{"format":"int64","description":"Actual total price of the trade.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"executedAt":{"format":"date-time","type":"string","description":"Timestamp when the trade was executed"},"executionOrder":{"type":"string","description":"Order in which the trade was executed"}},"required":["createdAt","updatedAt","id","marketId","listingId","baseAssetId","quoteAssetId","sellOrderId","sellAccountAddress","buyOrderId","buyAccountAddress","amount","price","totalPrice","executedAt","executionOrder"]},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The ListingEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ListingEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the market listing event","allOf":[{"$ref":"#/components/schemas/ListingDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"ListingDto":{"type":"object","properties":{"id":{"type":"string","description":"Listing UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market UUID identifier this listing belongs to","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset Id","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset Id","format":"uuid"},"status":{"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator","allOf":[{"$ref":"#/components/schemas/ListingStatus"}]},"tickSizeStrategy":{"description":"Strategy used to resolve the effective tick size for the listing","allOf":[{"$ref":"#/components/schemas/TickSizeStrategy"}]},"tickSize":{"description":"Tick size the order prices must conform to.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/TickSize"}],"nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Timestamp when the listing was initiated"},"listedAt":{"format":"date-time","type":"string","description":"Timestamp when the asset pair was listed","nullable":true},"delistingInitiatedAt":{"format":"date-time","type":"string","description":"Timestamp when the delisting was initiated","nullable":true},"delistedAt":{"format":"date-time","type":"string","description":"Timestamp when the asset pair was delisted","nullable":true},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string","description":"Blockchain transaction hash that last updated this listing"}},"required":["id","marketId","baseAssetId","quoteAssetId","status","tickSizeStrategy","tickSize","initiatedAt","listedAt","delistingInitiatedAt","delistedAt","createdAt","updatedAt"]},"ListingStatus":{"type":"string","enum":["delisted","delisting-initiated","halted","listed","listing-cancelled","listing-initiated","listing-rejected"],"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator"},"TickSizeStrategy":{"type":"string","enum":["static","tiered","volume-based"],"description":"Strategy used to resolve the effective tick size for the listing"},"TickSize":{"allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}],"format":"int64","enum":[100,200,500,1000,2000,5000,10000,20000,50000,100000,200000,500000,1000000,2000000,5000000,10000000,20000000,50000000,100000000,200000000,500000000],"description":"Permitted tick sizes (MiFID II RTS 11). E.g. `100` = `0.0001`, `10000` = `0.01`, `1000000` = `1`, `500000000` = `500`.\n\nScaled as `ScaledDecimal`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The MarketEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MarketEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the market event","allOf":[{"$ref":"#/components/schemas/MarketDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"MarketDto":{"type":"object","properties":{"status":{"description":"**Status of the market:**\n- `open` - market is open and accepting trades\n- `closed` - market is closed and not accepting trades\n- `halted` - market is halted and not accepting trades, until unhalted","allOf":[{"$ref":"#/components/schemas/MarketStatus"}]},"closureReason":{"description":"**Market closure reason (required if market is closed)**\n- `holiday` - market is closed due to holiday\n- `non-trading-hours` - market is closed due to non-trading hours (e.g. overnight, weekends, etc)\n- `post-halt` - market is closed because a halt has just ended within working hours; the market will be automatically reopened on the next scheduler tick. System-set only.\n- `scheduled-maintenance` - market is closed due to scheduled maintenance","allOf":[{"$ref":"#/components/schemas/MarketClosureReason"}]},"name":{"type":"string","description":"Name of the market"},"identifierCode":{"type":"string","description":"Market Identifier Code (MIC) as per ISO 10383 standard","pattern":"^[A-Z]{4}$","format":"iso-10383","minLength":4,"maxLength":4},"tz":{"type":"string","description":"Time zone (IANA) that market operates in","format":"iana-time-zone"},"workingHours":{"description":"Working hours on weekly basis","allOf":[{"$ref":"#/components/schemas/WeeklyWorkHoursDto"}]}},"required":["status","closureReason","name","identifierCode","tz","workingHours"]},"MarketStatus":{"type":"string","enum":["open","closed","halted"],"description":"**Status of the market:**\n- `open` - market is open and accepting trades\n- `closed` - market is closed and not accepting trades\n- `halted` - market is halted and not accepting trades, until unhalted"},"MarketClosureReason":{"type":"string","enum":["holiday","non-trading-hours","post-halt","scheduled-maintenance"],"description":"**Market closure reason (required if market is closed)**\n- `holiday` - market is closed due to holiday\n- `non-trading-hours` - market is closed due to non-trading hours (e.g. overnight, weekends, etc)\n- `post-halt` - market is closed because a halt has just ended within working hours; the market will be automatically reopened on the next scheduler tick. System-set only.\n- `scheduled-maintenance` - market is closed due to scheduled maintenance"},"WeeklyWorkHoursDto":{"type":"object","properties":{"monday":{"description":"Monday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"tuesday":{"description":"Tuesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"wednesday":{"description":"Wednesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"thursday":{"description":"Thursday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"friday":{"description":"Friday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"saturday":{"description":"Saturday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"sunday":{"description":"Sunday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]}}},"WorkHoursDto":{"type":"object","properties":{"open":{"type":"string","description":"Opening time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"close":{"type":"string","description":"Closing time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5}},"required":["open","close"]}}}}
```

## The NodeDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"NodeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Node UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Node type","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"accountAddress":{"type":"string","description":"Node account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"signerPublicKey":{"type":"string","description":"Node public key"},"signerAccountAddress":{"type":"string","description":"Node signer address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isCurrent":{"type":"boolean","description":"Is this the node"},"configUrl":{"type":"string","description":"IPFS link to node config","nullable":true}},"required":["createdAt","updatedAt","id","type","accountAddress","signerPublicKey","signerAccountAddress","isCurrent","configUrl"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"}}}}
```

## The NodeEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"NodeEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the node event","allOf":[{"$ref":"#/components/schemas/NodeDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"NodeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Node UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Node type","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"accountAddress":{"type":"string","description":"Node account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"signerPublicKey":{"type":"string","description":"Node public key"},"signerAccountAddress":{"type":"string","description":"Node signer address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isCurrent":{"type":"boolean","description":"Is this the node"},"configUrl":{"type":"string","description":"IPFS link to node config","nullable":true}},"required":["createdAt","updatedAt","id","type","accountAddress","signerPublicKey","signerAccountAddress","isCurrent","configUrl"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"}}}}
```

## The OtcTradeFopEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"OtcTradeFopEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the OTC FOP event","allOf":[{"$ref":"#/components/schemas/OtcTradeFopDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"OtcTradeFopDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"OTC FOP Trade UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the trade","allOf":[{"$ref":"#/components/schemas/OtcTradeFopStatus"}]},"assetId":{"type":"string","description":"Initiator asset id","format":"uuid"},"amount":{"format":"int64","description":"Initiator amount to send.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"initiatorAccountAddress":{"type":"string","description":"Initiator account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"initiatorBrokerId":{"type":"string","description":"Initiator broker id","format":"uuid"},"acceptorAccountAddress":{"type":"string","description":"Acceptor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"acceptorBrokerId":{"type":"string","description":"Acceptor broker id","format":"uuid"},"reason":{"description":"Reason for the trade","nullable":true,"allOf":[{"$ref":"#/components/schemas/OtcReason"}]},"tradedAt":{"format":"date-time","type":"string","description":"Trade date"}},"required":["createdAt","updatedAt","id","status","assetId","amount","initiatorAccountAddress","initiatorBrokerId","acceptorAccountAddress","acceptorBrokerId","reason","tradedAt"]},"OtcTradeFopStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"OtcReason":{"type":"string","enum":["internal","external","restriction","error","client-instruction"],"description":"Reason for the trade"}}}}
```

## The SupplyChangeEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SupplyChangeEventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the supply change event","allOf":[{"$ref":"#/components/schemas/SupplyChangeDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"SupplyChangeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Supply Change UUID identifier, global in scope of TSS","format":"uuid"},"assetId":{"type":"string","description":"Unique UUID of the asset in scope of this gateway","format":"uuid"},"status":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeStatus"}]},"amount":{"format":"int64","description":"Amount change in supply requested (positive for issuance, negative for burn).\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"action":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeAction"}]},"initiationReference":{"type":"string","description":"Reference provided by the broker during supply change initiation"},"validationReference":{"type":"string","description":"Reference provided by the operator during supply change validation","nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Date when the supply change was initiated"},"validatedAt":{"type":"string","description":"Date when the supply change was validated","format":"date-time","nullable":true}},"required":["createdAt","updatedAt","id","assetId","status","amount","action","initiationReference","validationReference","initiatedAt","validatedAt"]},"SupplyChangeStatus":{"type":"string","enum":["approved","cancelled","completed","initiated","rejected"],"description":"Status of supply change request"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"SupplyChangeAction":{"type":"string","enum":["additionalTokenisation","initialTokenisation","issuance","redemption","supplyDecrease","supplyIncrease"],"description":"Action of supply change request"}}}}
```

## The CreateWebhookDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"CreateWebhookDto":{"type":"object","properties":{"eventType":{"description":"Event type the webhook is listening to","allOf":[{"$ref":"#/components/schemas/EventType"}]},"url":{"type":"string","description":"Url to be called when the event is triggered"}},"required":["eventType","url"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"}}}}
```

## The WebhookDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"WebhookDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook UUID identifier, unique in scope of this node","format":"uuid"},"eventType":{"description":"Event type the webhook is listening to","allOf":[{"$ref":"#/components/schemas/EventType"}]},"url":{"type":"string","description":"Url to be called when the event is triggered"}},"required":["createdAt","updatedAt","id","eventType","url"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"}}}}
```

## The FilterWebhookDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterWebhookDto":{"type":"object","properties":{"id":{"description":"Filter by webhook ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"eventType":{"description":"Filter by event type(s)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/EventType"},"minItems":1},{"$ref":"#/components/schemas/EventType"}]},"url":{"type":"string","description":"Filter by url"},"createdAt":{"format":"date-time","description":"Filter webhooks created from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"}}}}
```

## The ErrorDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ErrorDto":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}}}}
```

## The DispatchErrorDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DispatchErrorDto":{"type":"object","properties":{"error":{"description":"Failure dispatch details","allOf":[{"$ref":"#/components/schemas/ErrorDto"}]}},"required":["error"]},"ErrorDto":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}}}}
```

## The DispatchSuccessDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DispatchSuccessDto":{"type":"object","properties":{"data":{"description":"Response payload","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}],"nullable":true}},"required":["data"]}}}}
```

## The DispatchDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DispatchDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook dispatch UUID identifier, unique in scope of this node","format":"uuid"},"webhookId":{"type":"string","description":"Id of the webhook subscription","format":"uuid"},"eventId":{"type":"string","description":"Id of the associated event","format":"uuid"},"status":{"type":"number","description":"HTTP status code of the webhook dispatch","format":"http-status","nullable":true},"result":{"description":"Dispatch result: error or response payload","oneOf":[{"$ref":"#/components/schemas/DispatchErrorDto"},{"$ref":"#/components/schemas/DispatchSuccessDto"}],"nullable":true}},"required":["createdAt","updatedAt","id","webhookId","eventId","status","result"]},"DispatchErrorDto":{"type":"object","properties":{"error":{"description":"Failure dispatch details","allOf":[{"$ref":"#/components/schemas/ErrorDto"}]}},"required":["error"]},"ErrorDto":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]},"DispatchSuccessDto":{"type":"object","properties":{"data":{"description":"Response payload","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}],"nullable":true}},"required":["data"]}}}}
```

## The FilterDispatchDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterDispatchDto":{"type":"object","properties":{"id":{"description":"Filter by ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"webhookId":{"description":"Filter by webhook ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"eventId":{"description":"Filter by event ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"status":{"description":"Filter by status","oneOf":[{"type":"array","items":{"description":"HTTP status codes","format":"http-status","type":"number"},"minItems":1},{"description":"HTTP status code","format":"http-status","type":"number"}]},"createdAt":{"format":"date-time","description":"Filter events from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}}}}}
```

## The EventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"EventDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Webhook event UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Type of event","allOf":[{"$ref":"#/components/schemas/EventType"}]},"data":{"description":"Data of the webhook event","oneOf":[{"$ref":"#/components/schemas/AccountDto"},{"$ref":"#/components/schemas/AuctionDto"},{"$ref":"#/components/schemas/BidDto"},{"$ref":"#/components/schemas/BondDto"},{"$ref":"#/components/schemas/BrokerDto"},{"$ref":"#/components/schemas/CouponDto"},{"$ref":"#/components/schemas/CurrencyDto"},{"$ref":"#/components/schemas/DataValidationDto"},{"$ref":"#/components/schemas/DepositDto"},{"$ref":"#/components/schemas/DistributionFopDto"},{"$ref":"#/components/schemas/IssuerDto"},{"$ref":"#/components/schemas/ListingDto"},{"$ref":"#/components/schemas/MarketAssetDto"},{"$ref":"#/components/schemas/MarketDto"},{"$ref":"#/components/schemas/MarketHaltDto"},{"$ref":"#/components/schemas/MaturityPaymentDto"},{"$ref":"#/components/schemas/NodeDto"},{"$ref":"#/components/schemas/OrderDto"},{"$ref":"#/components/schemas/OtcTradeFopDto"},{"$ref":"#/components/schemas/RedemptionDto"},{"$ref":"#/components/schemas/SubscriptionDto"},{"$ref":"#/components/schemas/SupplyChangeDto"},{"$ref":"#/components/schemas/TradeDto"},{"$ref":"#/components/schemas/WithdrawalDto"}]}},"required":["createdAt","updatedAt","id","type","data"]},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"},"AccountDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this account","format":"uuid"},"address":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of account","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"walletType":{"description":"Indicates that funds are owned by either broker or client","nullable":true,"allOf":[{"$ref":"#/components/schemas/WalletType"}]},"status":{"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done","allOf":[{"$ref":"#/components/schemas/AccountStatus"}]},"openedAt":{"format":"date-time","type":"string","description":"Opened date"}},"required":["createdAt","updatedAt","nodeId","address","type","institutionSectorCode","walletType","status","openedAt"]},"AccountType":{"type":"string","enum":["broker","emi","funding","investor","issuer","issuing","node","operational","operator"],"description":"Type of account"},"InstitutionSectorCode":{"type":"string","enum":["S.11","S.121","S.122","S.123","S.124","S.125","S.126","S.127","S.128","S.129","S.13","S.1311","S.1312","S.1313","S.1314","S.14","S.15"],"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form."},"WalletType":{"type":"string","enum":["broker-own","client-individual"],"description":"Indicates that funds are owned by either broker or client"},"AccountStatus":{"type":"string","enum":["active","frozen","deleted"],"description":"**Status of the account:**\n- `active` - account is allowed to interact with the system\n- `frozen` - no assets can be moved around\n- `deleted` - no further actions can be done"},"AuctionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Auction UUID identifier, unique in scope of this node","format":"uuid"},"brokerId":{"type":"string","description":"Broker id","format":"uuid"},"assetId":{"type":"string","description":"Asset id","format":"uuid"},"type":{"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive","allOf":[{"$ref":"#/components/schemas/AuctionType"}]},"status":{"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent","allOf":[{"$ref":"#/components/schemas/AuctionStatus"}]},"minAmount":{"format":"int64","description":"Minimal amount that needs to be auctioned off for the auction to succeed.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"price":{"format":"int64","description":"Minimal or fixed price, determined by auction type.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"startAt":{"format":"date-time","type":"string","description":"Date and time of auction opening"},"endAt":{"format":"date-time","type":"string","description":"Date and time of auction closing"},"settledAmount":{"nullable":true,"description":"Total settled amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledTotalPrice":{"nullable":true,"description":"Settled total price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledAt":{"format":"date-time","type":"string","description":"Date and time of auction settlement","nullable":true}},"required":["createdAt","updatedAt","id","brokerId","assetId","type","status","minAmount","price","startAt","endAt","settledAmount","settledTotalPrice","settledAt"]},"AuctionType":{"type":"string","enum":["fixed-price","min-price"],"description":"Type of auction:\n\n    'fixed-price' - price is fixed\n    'min-price' - price is limited to lower boundary, inclusive"},"AuctionStatus":{"type":"string","enum":["upcoming","open","closed","settled","failed","cancelled"],"description":"**Auction status:**\n- `upcoming` - will open in the future\n- `open` - currently open and accepts bids\n- `closed` - successful, but not yet settled\n- `settled` - successful and settled\n- `failed` - unsuccessful auction, `minAmount` not reached\n- `cancelled` - cancelled by issuer agent"},"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."},"BidDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bid UUID identifier, unique in scope of this node","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID that placed the bid","format":"uuid"},"assetId":{"type":"string","description":"Asset UUID that the bid is for","format":"uuid"},"auctionId":{"type":"string","description":"Auction UUID that the bid is for","format":"uuid"},"accountAddress":{"type":"string","description":"Account address that placed the bid","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"status":{"description":"Auction bid status","allOf":[{"$ref":"#/components/schemas/BidStatus"}]},"amount":{"format":"int64","description":"Bond amount the bid is for.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"price":{"format":"int64","description":"Bond price per unit.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalPrice":{"format":"int64","description":"Total bid price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"placedAt":{"format":"date-time","type":"string","description":"Bid placement time","nullable":true},"settledAmount":{"nullable":true,"description":"Settled amount the bid is for.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledTotalPrice":{"nullable":true,"description":"Settled total price.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"settledAt":{"format":"date-time","type":"string","description":"Bid settlement time","nullable":true}},"required":["createdAt","updatedAt","id","brokerId","assetId","auctionId","accountAddress","status","amount","price","totalPrice","placedAt","settledAmount","settledTotalPrice","settledAt"]},"BidStatus":{"type":"string","enum":["placed","funded","matched","settled","not-matched","rejected","cancelled"],"description":"**Create bid status:**\n- `placed` - place unfunded bid\n- `funded` - place funded bid"},"BondDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Bond UUID identifier, global in scope of TSS","format":"uuid"},"issuerId":{"type":"string","description":"Unique UUID of the issuer in scope of this gateway","format":"uuid"},"currencyId":{"type":"string","description":"Unique UUID of the currency that payouts of the bond are made with in scope of this gateway","format":"uuid"},"brokerId":{"type":"string","description":"Unique UUID of the broker that manages this bond issue","format":"uuid"},"origin":{"description":"Origin of the bond","allOf":[{"$ref":"#/components/schemas/BondOrigin"}]},"custodian":{"type":"string","description":"Custodian where asset is registered outside","nullable":true},"custodianLeiCode":{"type":"string","description":"LEI code of original depository where the issuer has registered the securities","nullable":true},"issuerCsdLeiCode":{"type":"string","description":"LEI code of central securities depository where the issuer has registered the securities","nullable":true},"csdRegisteredAt":{"type":"string","description":"Date of registration in central depository","format":"date-time","nullable":true},"underlyingInstrumentCode":{"type":"string","description":"Underlying instrument code","nullable":true},"fisn":{"type":"string","description":"Financial Instrument Short Name (FISN) as per ISO 18774:2024","format":"iso-18774-fisn","maxLength":35,"nullable":true},"countryCode":{"type":"string","description":"Country code of where the security is issued"},"turnoverType":{"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred","nullable":true,"allOf":[{"$ref":"#/components/schemas/TurnoverType"}]},"seniority":{"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation","allOf":[{"$ref":"#/components/schemas/BondSeniority"}]},"status":{"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)","allOf":[{"$ref":"#/components/schemas/BondStatus"}]},"initialPlacement":{"description":"Initial placement type","default":"public","allOf":[{"$ref":"#/components/schemas/InitialPlacementType"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isin":{"type":"string","description":" International Securities Identification Number. Code that uniquely identifies a security globally","nullable":true},"cfi":{"type":"string","description":"Classification of Financial Instruments (CFI) code as per ISO 10962","format":"iso-10962-cfi","pattern":"^[A-Z]{6}$","nullable":true},"figi":{"type":"string","description":"Financial Instrument Global Identifier. Code that uniquely identifies a security globally","nullable":true},"ticker":{"type":"string","description":"Stock ticker symbol. This is a unique series of letters assigned to a security or stock for trading purposes","nullable":true},"dti":{"type":"string","description":"Digital Token Identifier (DTI) as per ISO 24165","format":"iso-24165-dti","pattern":"^[B-DF-HJ-NP-TV-XZ1-9][B-DF-HJ-NP-TV-XZ0-9]{8}$","nullable":true},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"issuePrice":{"type":"string","description":"Price of the bond issue"},"nominalValue":{"format":"int64","description":"Nominal value of a single bond unit, also known as face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalNominalValue":{"format":"int64","description":"Nominal value of a full bond issue, also known as total face value.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"type":"string","description":"Annual interest rate in % paid for holding this bond"},"interestType":{"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference","allOf":[{"$ref":"#/components/schemas/InterestType"}]},"interestBase":{"description":"Interest calculation option","allOf":[{"$ref":"#/components/schemas/InterestBaseOptions"}]},"interestInterval":{"description":"Interest payment interval","allOf":[{"$ref":"#/components/schemas/InterestIntervalOptions"}]},"settlementUnitMultiple":{"type":"string","description":"Settlement unit multiple expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"minimumSettlementUnit":{"type":"string","description":"Minimum settlement unit expressed in maximum decimal points amount allowed. Ex: 0,01 means 2"},"prospectusRegistered":{"type":"boolean","description":"Indicator, if the bond prospectus registered"},"preEmptiveRights":{"type":"boolean","description":"Indicator, if the bond has pre-emptive rights"},"earlyRedemption":{"type":"boolean","description":"Indicator, if the bond can be redeemed early"},"secured":{"type":"boolean","description":"Indicator, if the bond is secured"},"securedBacking":{"type":"string","description":"Backing of the secured bond","nullable":true},"issuedAt":{"format":"date-time","type":"string","description":"Issue date of the bond."},"issuanceRecordAt":{"format":"date-time","type":"string","description":"Bond issue record date, from which the coupon accumulation starts."},"settleAt":{"format":"date-time","type":"string","description":"Date when the bond was or is expected to be fully distributed among initial holders."},"maturityRecordAt":{"format":"date-time","type":"string","description":"Date when the bond reaches maturity and final owners are fixed."},"matureAt":{"format":"date-time","type":"string","description":"Date when the bond maturity is expected to be paid out."},"distributedAmount":{"format":"int64","description":"Amount of bonds that have been proposed to distribute to investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestedAmount":{"format":"int64","description":"Amount of mature bonds requested to collect from investors.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"collectedAmount":{"format":"int64","description":"Amount of mature bonds collected back.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"name":{"type":"string","description":"Bond name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current bond supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total bond supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"couponIds":{"description":"Coupon ids","type":"array","items":{"type":"string"}},"maturityPaymentIds":{"description":"Maturity payment ids","type":"array","items":{"type":"string"}},"distributionIds":{"description":"Distribution ids","type":"array","items":{"type":"string"}},"settlementType":{"description":"**Corporate actions settlement type:**\n- `internal` - payments (coupons, maturity) are settled within Axiology TSS using EMTs\n- `external` - payments are settled via bank or other payment systems outside Axiology TSS","allOf":[{"$ref":"#/components/schemas/SettlementType"}]},"displayNotation":{"description":"Display hint only. The bond's monetary fields are returned as scaled monetary amounts regardless of this value; consumers use it to decide whether to render values as a percentage of nominal or as a per-unit amount.","allOf":[{"$ref":"#/components/schemas/PriceNotation"}]}},"required":["createdAt","updatedAt","id","issuerId","currencyId","brokerId","origin","custodian","custodianLeiCode","issuerCsdLeiCode","csdRegisteredAt","underlyingInstrumentCode","fisn","countryCode","turnoverType","seniority","status","initialPlacement","issuingAccountAddress","operationalAccountAddress","isin","cfi","figi","ticker","dti","ecbClassification","bolClassification","issuePrice","nominalValue","totalNominalValue","interestRate","interestType","interestBase","interestInterval","settlementUnitMultiple","minimumSettlementUnit","prospectusRegistered","preEmptiveRights","earlyRedemption","secured","securedBacking","issuedAt","issuanceRecordAt","settleAt","maturityRecordAt","matureAt","distributedAmount","requestedAmount","collectedAmount","name","specUrl","exponent","supply","totalSupply","couponIds","maturityPaymentIds","distributionIds","settlementType","displayNotation"]},"BondOrigin":{"type":"string","enum":["native","tokenized"],"description":"Origin of the bond"},"TurnoverType":{"type":"string","enum":["public","private"],"description":"Type of turnover for the bond. Indicates how the bond is traded or transferred"},"BondSeniority":{"type":"string","enum":["senior-debt","mezzanine","subordinated-debt","junior-debt"],"description":"Seniority of the bond. Indicates the priority of claims in case of liquidation"},"BondStatus":{"type":"string","enum":["draft","recorded","issued","distributing","live","locked","mature","collecting","collected","closed"],"description":"**Status of the bond:**\n- `draft`- bond is created\n- `recorded`- data validation was created by issuer agent and approved by operator\n- `issued`- supply change was created by issuer agent and approved by operator\n- `distributing`- bond has been recorded, issued and ongoing distribution (step 1/2)\n- `live`- bond is distributed (step 2/2), now live and circulating\n- `locked`- bond is locked from trading, entering maturity process (step 1/5)\n- `mature`- bond is maturing, cannot be traded or transferred (step 2/5)\n- `collecting`- bond collection in progress (step 3/5)\n- `collected`- bond collection completed (step 4/5)\n- `closed`- bond has reached the end of its lifecycle (step 5/5)"},"InitialPlacementType":{"type":"string","enum":["public","private"],"description":"Initial placement type"},"PAC2":{"type":"string","enum":["C","D","D.1","D.11","D.12","D.121","D.122","D.129","D.13","D.131","D.139","D.14","D.141","D.149","D.15","D.16","D.161","D.162","D.163","D.164","D.165","D.166","D.167","D.169","D.17","D.171","D.172","D.18","D.181","D.1811","D.1812","D.1813","D.1819","D.182","D.1821","D.1822","D.1823","D.1829","D.19","D.2","D.21","D.22","D.23","D.231","D.232","D.239","D.24","D.29","D.3","D.31","D.311","D.32","D.33","D.34","D.39","D.9","E","E.1","E.2","E.21","E.22","E.23","E.24","E.29","E.3","E.31","E.32","E.39","E.4","E.41","E.42","E.43","E.49","E.9","F","F.1","F.2","F.9","I","L","M","O","P","R","U"],"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists."},"BoLSecurityTypeCode":{"type":"string","enum":["100","101","102","103","104","106","107","108","305","400","900","N/A"],"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code."},"InterestType":{"type":"string","enum":["fixed","index-linked","other","stepped","floating","zero-coupon"],"description":"**Interest type of the bond** using Axiology bond terminology.\n- `fixed` - fixed-rate debt security with a coupon rate that remains constant for the life of the instrument\n- `index-linked` - debt security whose coupon and/or redemption amount is linked to a reference index, for example an inflation index\n- `other` - residual category for debt securities whose interest structure does not fit the named interest-type categories\n- `stepped` - stepped-coupon debt security with a predefined coupon step-up or step-down schedule\n- `floating` - floating-rate debt security with a coupon that is periodically reset against a reference rate\n- `zero-coupon` - zero-coupon debt security with no periodic coupon payments; return is realised through the issue/redemption price difference"},"InterestBaseOptions":{"type":"string","enum":["act-act","act-360","act-365","thirty-360","thirty-e-360"],"description":"Interest calculation option"},"InterestIntervalOptions":{"type":"string","enum":["annual","monthly","quarterly","semiannual"],"description":"Interest payment interval"},"SettlementType":{"type":"string","enum":["external","internal"],"description":"**Corporate actions settlement type:**\n- `internal` - settled within Axiology TSS using EMTs\n- `external` - settled via bank or other payment systems outside Axiology TSS"},"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."},"BrokerDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"email":{"type":"string","description":"Email of a participant","format":"email","nullable":true},"leiCode":{"type":"string","description":"Legal Entity Identifier (LEI) code","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"representorCompanyCode":{"type":"string","description":"Company registration number of participant representor","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$","nullable":true},"countryCode":{"type":"string","description":"Country code of the participant","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"branchCountryCode":{"type":"string","description":"Country code of the branch","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"bic":{"type":"string","description":"Bank Identifier Code (BIC)","format":"bic","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"isLiquidityProvider":{"type":"boolean","description":"Is participant a liquidity provider in the market","default":false},"id":{"type":"string","description":"Broker UUID identifier, global in scope of TSS","format":"uuid"},"ibans":{"description":"List of IBANs used for deposits and withdrawals","type":"array","items":{"$ref":"#/components/schemas/TypedIban"}}},"required":["createdAt","updatedAt","name","email","leiCode","companyCode","representorCompanyCode","countryCode","branchCountryCode","institutionSectorCode","bic","isLiquidityProvider","id","ibans"]},"TypedIban":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN of the wallet","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"type":{"description":"Type of the wallet","allOf":[{"$ref":"#/components/schemas/WalletType"}]}},"required":["iban","type"]},"CouponDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Coupon UUID identifier, global in scope of TSS","format":"uuid"},"no":{"type":"number","description":"Coupon №"},"bondId":{"type":"string","description":"Bond UUID, unique in scope of this node","format":"uuid"},"status":{"description":"Coupon status","allOf":[{"$ref":"#/components/schemas/CouponStatus"}]},"totalPayment":{"format":"int64","description":"Total payment of coupon, in the bond currency.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"interestRate":{"nullable":true,"description":"Annual interest rate applicable to this coupon period. Null when not yet set.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"recordAt":{"format":"date-time","type":"string","description":"Date of coupon's period end, bond holders are recorded."},"payAt":{"format":"date-time","type":"string","description":"Date of coupon's payment, must be later than record date."}},"required":["createdAt","updatedAt","id","no","bondId","status","totalPayment","interestRate","recordAt","payAt"]},"CouponStatus":{"type":"string","enum":["paid","readyToPay","upcoming","paying","noFunds"],"description":"Coupon status"},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."},"CurrencyDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Currency UUID identifier, global in scope of TSS","format":"uuid"},"name":{"type":"string","description":"Full name of the currency"},"code":{"type":"string","description":"Unique code of the currency"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supplyLimit":{"format":"int64","description":"Maximum amount of currency allowed in circulation.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"}},"required":["createdAt","updatedAt","id","name","code","exponent","supplyLimit","issuingAccountAddress","operationalAccountAddress"]},"DataValidationDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Data validation UUID identifier, global in scope of TSS","format":"uuid"},"assetId":{"type":"string","description":"Unique UUID of the asset in scope of this gateway","format":"uuid"},"status":{"allOf":[{"$ref":"#/components/schemas/DataValidationStatus"}]},"specUrl":{"type":"string","description":"IPFS link with data that was validated or needs to be validated"},"initiationReference":{"type":"string","description":"Reference provided by the broker during data validation initiation"},"validationReference":{"type":"string","description":"Reference provided by the operator during data validation","nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Date when the data validation was initiated"},"validatedAt":{"type":"string","description":"Date when the data validation was completed","format":"date-time","nullable":true}},"required":["createdAt","updatedAt","id","assetId","status","specUrl","initiationReference","validationReference","initiatedAt","validatedAt"]},"DataValidationStatus":{"type":"string","enum":["approved","cancelled","initiated","rejected"],"description":"**Data validation status:**\n- `initiated` - data validation has been requested and is awaiting operator review\n- `approved` - operator approved the data validation\n- `rejected` - operator rejected the data validation\n- `cancelled` - data validation was cancelled by the broker"},"DepositDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Deposit UUID identifier, global in scope of TSS","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID identifier","format":"uuid"},"currencyId":{"type":"string","description":"Currency UUID identifier","format":"uuid"},"accountAddress":{"type":"string","description":"Destination account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"iban":{"type":"string","description":"Source IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"amount":{"format":"int64","description":"Deposit amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status of deposit","allOf":[{"$ref":"#/components/schemas/DepositStatus"}]},"transactionId":{"type":"string","description":"SEPA payment's Transaction Id","format":"iso-20022-payment-tx-id","minLength":10,"maxLength":35},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["createdAt","updatedAt","id","brokerId","currencyId","accountAddress","iban","amount","status","transactionId","correlationId"]},"DepositStatus":{"type":"string","enum":["approved","deposited","initiated","rejected"],"description":"Status of deposit"},"DistributionFopDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Distribution FOP UUID identifier, unique in scope of this node","format":"uuid"},"distributionId":{"type":"string","description":"Distribution id","format":"uuid"},"assetId":{"type":"string","description":"Asset id","format":"uuid"},"accountAddress":{"type":"string","description":"Account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount to receive.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status","allOf":[{"$ref":"#/components/schemas/DistributionFopStatus"}]},"settledAt":{"format":"date-time","type":"string","description":"Date and time of distribution FOP"}},"required":["createdAt","updatedAt","id","distributionId","assetId","accountAddress","amount","status","settledAt"]},"DistributionFopStatus":{"type":"string","enum":["upcoming","initiated","initiation-failed","completed","completion-failed"],"description":"**Update distribution FOP status**\n- `initiated` - (issuer agent) initiate `upcoming` or `initiation-failed` FOP distribution\n- `completed` - (investor agent) complete `initiated` FOP distribution"},"IssuerDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Issuer UUID identifier, unique in scope of this node","format":"uuid"},"type":{"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer","allOf":[{"$ref":"#/components/schemas/IssuerType"}]},"accountAddress":{"type":"string","description":"Issuer account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"name":{"type":"string","description":"Name of the company","minLength":1,"maxLength":256},"companyCode":{"type":"string","description":"Company registration code","maxLength":30,"minLength":6,"pattern":"^[A-Z0-9]{6-30}$"},"address":{"type":"string","description":"Address of headquarters"},"postalAddress":{"type":"string","description":"Address of headquarters"},"countryCode":{"type":"string","description":"Country code of where the issuing company is located","format":"iso3166-1-alpha-2","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"leiCode":{"type":"string","description":"Unique identifier of the company/institution issuing the asset (LEI - Legal Entity Identifier)","pattern":"^[A-Z0-9]{4}00[A-Z0-9]{14}$","format":"lei-code","minLength":20,"maxLength":20,"nullable":true},"vatCode":{"type":"string","description":"Value-added tax identification number","format":"vat-code","nullable":true},"email":{"type":"string","description":"Email of the issuing company’s representative","format":"email","nullable":true},"institutionSectorCode":{"description":"ESA 2010 / ECB institutional sector classification code used for statistical and regulatory reporting. This describes sector, not legal form.","allOf":[{"$ref":"#/components/schemas/InstitutionSectorCode"}]},"ratingAgency":{"type":"string","nullable":true},"rating":{"type":"string","nullable":true}},"required":["createdAt","updatedAt","id","type","accountAddress","name","companyCode","address","postalAddress","countryCode","leiCode","vatCode","email","institutionSectorCode","ratingAgency","rating"]},"IssuerType":{"type":"string","enum":["bank","government","investment-holding-company","other","plc","pllc","small-pllc","sole-proprietorship"],"description":"**Issuer type:**\n- `bank` - bank or credit institution issuer\n- `government` - government or public-sector issuer\n- `investment-holding-company` - investment holding company issuer\n- `other` - issuer type that does not fit the listed categories\n- `plc` - public limited company issuer\n- `pllc` - private limited liability company issuer\n- `small-pllc` - small private limited liability company issuer\n- `sole-proprietorship` - sole proprietorship issuer"},"ListingDto":{"type":"object","properties":{"id":{"type":"string","description":"Listing UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market UUID identifier this listing belongs to","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset Id","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset Id","format":"uuid"},"status":{"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator","allOf":[{"$ref":"#/components/schemas/ListingStatus"}]},"tickSizeStrategy":{"description":"Strategy used to resolve the effective tick size for the listing","allOf":[{"$ref":"#/components/schemas/TickSizeStrategy"}]},"tickSize":{"description":"Tick size the order prices must conform to.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/TickSize"}],"nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Timestamp when the listing was initiated"},"listedAt":{"format":"date-time","type":"string","description":"Timestamp when the asset pair was listed","nullable":true},"delistingInitiatedAt":{"format":"date-time","type":"string","description":"Timestamp when the delisting was initiated","nullable":true},"delistedAt":{"format":"date-time","type":"string","description":"Timestamp when the asset pair was delisted","nullable":true},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string","description":"Blockchain transaction hash that last updated this listing"}},"required":["id","marketId","baseAssetId","quoteAssetId","status","tickSizeStrategy","tickSize","initiatedAt","listedAt","delistingInitiatedAt","delistedAt","createdAt","updatedAt"]},"ListingStatus":{"type":"string","enum":["delisted","delisting-initiated","halted","listed","listing-cancelled","listing-initiated","listing-rejected"],"description":"**Status of the market listing:**\n- `listing-initiated` - listing has been initiated by the issuer agent\n- `listing-cancelled` - listing has been cancelled by the issuer agent\n- `listing-rejected` - listing request has been rejected by the operator\n- `listed` - asset is listed on the market\n- `delisting-initiated` - delisting has been initiated by the issuer agent, though still considered to be listed\n- `delisted` - asset has been delisted by the operator"},"TickSizeStrategy":{"type":"string","enum":["static","tiered","volume-based"],"description":"Strategy used to resolve the effective tick size for the listing"},"TickSize":{"allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}],"format":"int64","enum":[100,200,500,1000,2000,5000,10000,20000,50000,100000,200000,500000,1000000,2000000,5000000,10000000,20000000,50000000,100000000,200000000,500000000],"description":"Permitted tick sizes (MiFID II RTS 11). E.g. `100` = `0.0001`, `10000` = `0.01`, `1000000` = `1`, `500000000` = `500`.\n\nScaled as `ScaledDecimal`."},"MarketAssetDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Asset UUID identifier, global in scope of TSS","format":"uuid"},"nodeId":{"type":"string","description":"Unique UUID of the node that manages this asset","format":"uuid"},"issuingAccountAddress":{"type":"string","description":"Issuing account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"operationalAccountAddress":{"type":"string","description":"Operational account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"Type of the asset","allOf":[{"$ref":"#/components/schemas/AssetType"}]},"name":{"type":"string","description":"Asset name"},"specUrl":{"type":"string","description":"IPFS link"},"exponent":{"type":"number","description":"**Exponent** - number of decimal places (scale) used for this asset or currency.\n- Decimal floating value: `stored_value / 10^exponent`.\n- Values are stored in the smallest accountable/divisible unit (e.g., cents when exponent = 2).\n- Examples: `2000` with exponent `2` => `20`; `2345` with exponent `3` => `2.345`; `2345` with exponent `0` => `2345`.","minimum":0,"maximum":10},"supply":{"format":"int64","description":"Current asset supply.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"totalSupply":{"format":"int64","description":"Total asset supply ever issued.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"ecbClassification":{"description":"**ECB Primary Asset Classification (PAC2)** code used in ECB SHS/SHSG reporting codelists.","allOf":[{"$ref":"#/components/schemas/PAC2"}]},"bolClassification":{"description":"**Bank of Lithuania VPT security type code** used in securities holdings reporting forms `VPT-01` and `VPT-02`.\n- The `VPT-01` form points to Annex II of ECB Regulation (EU) No `1011/2012` for classification guidance.\n- This schema stores the numeric code values used by the system for Bank of Lithuania reporting.\n- `N/A` is an internal system value and not an official Bank of Lithuania reporting code.","allOf":[{"$ref":"#/components/schemas/BoLSecurityTypeCode"}]},"isTradeable":{"type":"boolean","description":"Indicates if the asset can be traded"},"marketId":{"type":"string","description":"Market UUID identifier this asset was/is listed on","format":"uuid"}},"required":["createdAt","updatedAt","id","nodeId","issuingAccountAddress","operationalAccountAddress","type","name","specUrl","exponent","supply","totalSupply","ecbClassification","bolClassification","isTradeable","marketId"]},"AssetType":{"type":"string","enum":["currency","bond","equity","fund"],"description":"Type of the asset"},"MarketDto":{"type":"object","properties":{"status":{"description":"**Status of the market:**\n- `open` - market is open and accepting trades\n- `closed` - market is closed and not accepting trades\n- `halted` - market is halted and not accepting trades, until unhalted","allOf":[{"$ref":"#/components/schemas/MarketStatus"}]},"closureReason":{"description":"**Market closure reason (required if market is closed)**\n- `holiday` - market is closed due to holiday\n- `non-trading-hours` - market is closed due to non-trading hours (e.g. overnight, weekends, etc)\n- `post-halt` - market is closed because a halt has just ended within working hours; the market will be automatically reopened on the next scheduler tick. System-set only.\n- `scheduled-maintenance` - market is closed due to scheduled maintenance","allOf":[{"$ref":"#/components/schemas/MarketClosureReason"}]},"name":{"type":"string","description":"Name of the market"},"identifierCode":{"type":"string","description":"Market Identifier Code (MIC) as per ISO 10383 standard","pattern":"^[A-Z]{4}$","format":"iso-10383","minLength":4,"maxLength":4},"tz":{"type":"string","description":"Time zone (IANA) that market operates in","format":"iana-time-zone"},"workingHours":{"description":"Working hours on weekly basis","allOf":[{"$ref":"#/components/schemas/WeeklyWorkHoursDto"}]}},"required":["status","closureReason","name","identifierCode","tz","workingHours"]},"MarketStatus":{"type":"string","enum":["open","closed","halted"],"description":"**Status of the market:**\n- `open` - market is open and accepting trades\n- `closed` - market is closed and not accepting trades\n- `halted` - market is halted and not accepting trades, until unhalted"},"MarketClosureReason":{"type":"string","enum":["holiday","non-trading-hours","post-halt","scheduled-maintenance"],"description":"**Market closure reason (required if market is closed)**\n- `holiday` - market is closed due to holiday\n- `non-trading-hours` - market is closed due to non-trading hours (e.g. overnight, weekends, etc)\n- `post-halt` - market is closed because a halt has just ended within working hours; the market will be automatically reopened on the next scheduler tick. System-set only.\n- `scheduled-maintenance` - market is closed due to scheduled maintenance"},"WeeklyWorkHoursDto":{"type":"object","properties":{"monday":{"description":"Monday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"tuesday":{"description":"Tuesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"wednesday":{"description":"Wednesday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"thursday":{"description":"Thursday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"friday":{"description":"Friday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"saturday":{"description":"Saturday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]},"sunday":{"description":"Sunday's opening hours","allOf":[{"$ref":"#/components/schemas/WorkHoursDto"}]}}},"WorkHoursDto":{"type":"object","properties":{"open":{"type":"string","description":"Opening time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5},"close":{"type":"string","description":"Closing time","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$","format":"time","minLength":5,"maxLength":5}},"required":["open","close"]},"MarketHaltDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Market halt UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market id where the halt applies","format":"uuid"},"status":{"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended","allOf":[{"$ref":"#/components/schemas/HaltStatus"}]},"startedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was started"},"reason":{"type":"string","description":"Reason for the halt","minLength":1,"maxLength":512},"endedAt":{"format":"date-time","type":"string","description":"Timestamp when the halt was ended","nullable":true},"resumeReason":{"type":"string","description":"Reason for resuming trading","minLength":1,"maxLength":512,"nullable":true}},"required":["createdAt","updatedAt","id","marketId","status","startedAt","reason","endedAt","resumeReason"]},"HaltStatus":{"type":"string","enum":["ended","started"],"description":"**Halt status:**\n- `started` - trading is currently halted\n- `ended` - trading halt has ended"},"MaturityPaymentDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Maturity Payment UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the maturity payment","allOf":[{"$ref":"#/components/schemas/MaturityPaymentStatus"}]},"bondId":{"type":"string","description":"Unique UUID of the bond in scope of this gateway","format":"uuid"},"bondAmount":{"format":"int64","description":"Bond amount for this maturity payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"payoutAmount":{"format":"int64","description":"Amount to pay for this maturity payment.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"receiverAddress":{"type":"string","description":"Payment`s receiver address corresponding to the investor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"errorMessage":{"type":"string","description":"Error message"}},"required":["createdAt","updatedAt","id","status","bondId","bondAmount","payoutAmount","receiverAddress"]},"MaturityPaymentStatus":{"type":"string","enum":["recorded","no-funds","initiated","initiation-failed","completed","completion-failed"],"description":"Status of the maturity payment"},"NodeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Node UUID identifier, global in scope of TSS","format":"uuid"},"type":{"description":"Node type","allOf":[{"$ref":"#/components/schemas/AccountType"}]},"accountAddress":{"type":"string","description":"Node account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"signerPublicKey":{"type":"string","description":"Node public key"},"signerAccountAddress":{"type":"string","description":"Node signer address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"isCurrent":{"type":"boolean","description":"Is this the node"},"configUrl":{"type":"string","description":"IPFS link to node config","nullable":true}},"required":["createdAt","updatedAt","id","type","accountAddress","signerPublicKey","signerAccountAddress","isCurrent","configUrl"]},"OrderDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Order UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market identifier where the order is placed","format":"uuid"},"listingId":{"type":"string","description":"Identifier of the market listing (trading pair)","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset identifier in the trading pair","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset identifier in the trading pair","format":"uuid"},"accountAddress":{"type":"string","description":"Investment account address that placed the order","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"type":{"description":"**Order execution strategy:**\n- `limit`: Executes at a specified price or better\n- `market`: Executes immediately at the best available price","allOf":[{"$ref":"#/components/schemas/OrderType"}]},"side":{"description":"**Side of the order indicating intent to buy or sell.**\n- `buy`: Order to purchase the base asset using the quote asset\n- `sell`: Order to sell the base asset in exchange for the quote asset","allOf":[{"$ref":"#/components/schemas/OrderSide"}]},"status":{"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled","allOf":[{"$ref":"#/components/schemas/OrderStatus"}]},"amount":{"format":"int64","description":"Amount of the base asset to trade.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"filledAmount":{"format":"int64","description":"Amount of the base asset that is filled.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"price":{"format":"int64","description":"Price per unit of the base asset, denominated in the quote asset.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"placedAt":{"format":"date-time","type":"string","description":"Placement date of the order"},"cancelledAt":{"format":"date-time","type":"string","description":"Cancellation date of the order","nullable":true},"cancelledReason":{"description":"**Order cancelled reason:**\n- `broker`: Order is cancelled by broker\n- `listing-delisted`: Order is cancelled by system because of delisted listing","nullable":true,"allOf":[{"$ref":"#/components/schemas/OrderCancelledReason"}]},"expiresAt":{"format":"date-time","type":"string","description":"Expiration date of the order","nullable":true}},"required":["createdAt","updatedAt","id","marketId","listingId","baseAssetId","quoteAssetId","accountAddress","type","side","status","amount","filledAmount","price","placedAt","cancelledAt","cancelledReason","expiresAt"]},"OrderType":{"type":"string","enum":["limit","market"],"description":"Type of the order execution"},"OrderSide":{"type":"string","enum":["buy","sell"],"description":"Side of the order indicating buy or sell"},"OrderStatus":{"type":"string","enum":["open","filled","rejected","cancelled","expired"],"description":"**Status of the order lifecycle:**\n- `open`: Order is active and not yet fully filled or cancelled\n- `filled`: Order has been fully filled/executed\n- `rejected`: Order could not be executed\n- `cancelled`: Order has been cancelled by the user or system\n- `expired`: Order has reached its expiration time without being fully filled"},"OrderCancelledReason":{"type":"string","enum":["broker","listing-delisted","bond-locked"],"description":"**Order cancelled reason:**\n- `broker`: Order is cancelled by broker\n- `listing-delisted`: Order is cancelled by system because of delisted listing"},"OtcTradeFopDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"OTC FOP Trade UUID identifier, unique in scope of this node","format":"uuid"},"status":{"description":"Status of the trade","allOf":[{"$ref":"#/components/schemas/OtcTradeFopStatus"}]},"assetId":{"type":"string","description":"Initiator asset id","format":"uuid"},"amount":{"format":"int64","description":"Initiator amount to send.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"initiatorAccountAddress":{"type":"string","description":"Initiator account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"initiatorBrokerId":{"type":"string","description":"Initiator broker id","format":"uuid"},"acceptorAccountAddress":{"type":"string","description":"Acceptor account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"acceptorBrokerId":{"type":"string","description":"Acceptor broker id","format":"uuid"},"reason":{"description":"Reason for the trade","nullable":true,"allOf":[{"$ref":"#/components/schemas/OtcReason"}]},"tradedAt":{"format":"date-time","type":"string","description":"Trade date"}},"required":["createdAt","updatedAt","id","status","assetId","amount","initiatorAccountAddress","initiatorBrokerId","acceptorAccountAddress","acceptorBrokerId","reason","tradedAt"]},"OtcTradeFopStatus":{"type":"string","enum":["initiated","completed","cancelled","rejected"],"description":"Status of the trade"},"OtcReason":{"type":"string","enum":["internal","external","restriction","error","client-instruction"],"description":"Reason for the trade"},"RedemptionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund redemption UUID identifier, global in scope of TSS","format":"uuid"},"fundId":{"type":"string","description":"Fund (asset) id the redemption is for","format":"uuid"},"investorBrokerId":{"type":"string","description":"Broker id of the investor's agent","format":"uuid"},"issuerBrokerId":{"type":"string","description":"Broker id of the fund issuer","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Lifecycle status of the redemption","allOf":[{"$ref":"#/components/schemas/RedemptionStatus"}]},"totalPrice":{"nullable":true,"description":"Settled cash proceeds, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"format":"int64","description":"Amount of fund units to redeem\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestReference":{"type":"string","description":"Reference provided when the redemption was requested","maxLength":256,"nullable":true},"resolutionReference":{"type":"string","description":"Reference provided when the redemption was settled, rejected or cancelled","maxLength":256,"nullable":true}},"required":["createdAt","updatedAt","id","fundId","investorBrokerId","issuerBrokerId","accountAddress","cashLegType","status","totalPrice","amount","requestReference","resolutionReference"]},"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"},"RedemptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund redemption status:**\n- `requested` - redemption requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; cash delivered to the investor"},"SubscriptionDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Fund subscription UUID identifier, global in scope of TSS","format":"uuid"},"fundId":{"type":"string","description":"Fund (asset) id the subscription is for","format":"uuid"},"investorBrokerId":{"type":"string","description":"Broker id of the investor's agent","format":"uuid"},"issuerBrokerId":{"type":"string","description":"Broker id of the fund issuer","format":"uuid"},"accountAddress":{"type":"string","description":"Investor wallet address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"cashLegType":{"description":"Cash leg settlement method","allOf":[{"$ref":"#/components/schemas/SettlementMethod"}]},"status":{"description":"Lifecycle status of the subscription","allOf":[{"$ref":"#/components/schemas/SubscriptionStatus"}]},"totalPrice":{"nullable":true,"description":"Requested or settled price, in the fund currency\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"amount":{"nullable":true,"description":"Requested or settled amount, in fund units\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"requestReference":{"type":"string","description":"Reference provided when the subscription was requested","maxLength":256,"nullable":true},"resolutionReference":{"type":"string","description":"Reference provided when the subscription was settled, rejected or cancelled","maxLength":256,"nullable":true}},"required":["createdAt","updatedAt","id","fundId","investorBrokerId","issuerBrokerId","accountAddress","cashLegType","status","totalPrice","amount","requestReference","resolutionReference"]},"SubscriptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund subscription status:**\n- `requested` - subscription requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; units delivered to the investor"},"SupplyChangeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Supply Change UUID identifier, global in scope of TSS","format":"uuid"},"assetId":{"type":"string","description":"Unique UUID of the asset in scope of this gateway","format":"uuid"},"status":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeStatus"}]},"amount":{"format":"int64","description":"Amount change in supply requested (positive for issuance, negative for burn).\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"action":{"allOf":[{"$ref":"#/components/schemas/SupplyChangeAction"}]},"initiationReference":{"type":"string","description":"Reference provided by the broker during supply change initiation"},"validationReference":{"type":"string","description":"Reference provided by the operator during supply change validation","nullable":true},"initiatedAt":{"format":"date-time","type":"string","description":"Date when the supply change was initiated"},"validatedAt":{"type":"string","description":"Date when the supply change was validated","format":"date-time","nullable":true}},"required":["createdAt","updatedAt","id","assetId","status","amount","action","initiationReference","validationReference","initiatedAt","validatedAt"]},"SupplyChangeStatus":{"type":"string","enum":["approved","cancelled","completed","initiated","rejected"],"description":"Status of supply change request"},"SupplyChangeAction":{"type":"string","enum":["additionalTokenisation","initialTokenisation","issuance","redemption","supplyDecrease","supplyIncrease"],"description":"Action of supply change request"},"TradeDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Trade UUID identifier, global in scope of TSS","format":"uuid"},"marketId":{"type":"string","description":"Market identifier where the trade occurred","format":"uuid"},"listingId":{"type":"string","description":"Identifier of the market listing (trading pair)","format":"uuid"},"baseAssetId":{"type":"string","description":"Base asset identifier in the trading pair","format":"uuid"},"quoteAssetId":{"type":"string","description":"Quote asset identifier in the trading pair","format":"uuid"},"sellOrderId":{"type":"string","description":"UUID identifier of the sell order","format":"uuid"},"sellAccountAddress":{"type":"string","description":"Sell investor's account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"buyOrderId":{"type":"string","description":"UUID identifier of the buy order","format":"uuid"},"buyAccountAddress":{"type":"string","description":"Buy investor's account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"amount":{"format":"int64","description":"Amount of the base asset traded.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"price":{"format":"int64","description":"Price per unit of the base asset, denominated in the quote asset.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"totalPrice":{"format":"int64","description":"Actual total price of the trade.\n\nScaled as `ScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}]},"executedAt":{"format":"date-time","type":"string","description":"Timestamp when the trade was executed"},"executionOrder":{"type":"string","description":"Order in which the trade was executed"}},"required":["createdAt","updatedAt","id","marketId","listingId","baseAssetId","quoteAssetId","sellOrderId","sellAccountAddress","buyOrderId","buyAccountAddress","amount","price","totalPrice","executedAt","executionOrder"]},"WithdrawalDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","description":"Created date"},"updatedAt":{"format":"date-time","type":"string","description":"Updated date"},"id":{"type":"string","description":"Withdrawal UUID identifier, global in scope of TSS","format":"uuid"},"brokerId":{"type":"string","description":"Broker UUID identifier","format":"uuid"},"currencyId":{"type":"string","description":"Currency UUID identifier","format":"uuid"},"accountAddress":{"type":"string","description":"Source account address","format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}"},"iban":{"type":"string","description":"Destination IBAN","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$","format":"iban","minLength":15,"maxLength":34},"amount":{"format":"int64","description":"Withdrawal amount.\n\nScaled as `ExponentScaledDecimal`.","allOf":[{"$ref":"#/components/schemas/ExponentScaledDecimal"}]},"status":{"description":"Status of withdrawal","allOf":[{"$ref":"#/components/schemas/WithdrawalStatus"}]},"transactionId":{"type":"string","description":"SEPA payment's Transaction Id","format":"iso-20022-payment-tx-id","minLength":10,"maxLength":35,"nullable":true},"correlationId":{"type":"string","description":"Correlation id for end-to-end referencing","format":"uuid"}},"required":["createdAt","updatedAt","id","brokerId","currencyId","accountAddress","iban","amount","status","transactionId","correlationId"]},"WithdrawalStatus":{"type":"string","enum":["failed","initiated","rejected","returned","started","withdrawn"],"description":"Status of withdrawal"}}}}
```

## The FilterEventDto object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"FilterEventDto":{"type":"object","properties":{"id":{"description":"Filter by event ID(s)","oneOf":[{"type":"array","items":{"description":"Unique UUIDs of an entity","format":"uuid","type":"string"},"minItems":1},{"description":"Unique UUID of an entity","format":"uuid","type":"string"}]},"type":{"description":"Filter by event type(s)","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/EventType"},"minItems":1},{"$ref":"#/components/schemas/EventType"}]},"createdAt":{"format":"date-time","description":"Filter events from date or between two dates","oneOf":[{"type":"array","items":{"type":"string","format":"date-time"},"minItems":1,"maxItems":2},{"type":"string","format":"date-time"}]}}},"EventType":{"type":"number","enum":["account.created","auction.bid.allocated","auction.bid.cancelled","auction.bid.defunded","auction.bid.funded","auction.bid.not-allocated","auction.bid.placed","auction.bid.refunded","auction.bid.settled","auction.cancelled","auction.closed","auction.created","auction.failed","auction.opened","auction.settled","bond.closed","bond.coupon.no-funds","bond.coupon.paid","bond.coupon.payout-pending","bond.coupon.payout-started","bond.coupon.status-changed","bond.drafted","bond.locked","bond.matured","bond.maturity-payment.completed","bond.maturity-payment.completion-failed","bond.maturity-payment.initiated","bond.maturity-payment.initiation-failed","bond.maturity-payment.no-funds","bond.maturity-payment.recorded","bond.maturity-payment.status-changed","bond.recorded","bond.redeemed","bond.status-changed","bond.supply-issued","bond.went-live","broker.created","broker.updated","currency.created","currency.deposit.deposited","currency.deposit.rejected","currency.withdrawal.rejected","currency.withdrawal.returned","currency.withdrawal.started","currency.withdrawal.withdrawn","data-validation.approved","data-validation.cancelled","data-validation.initiated","data-validation.rejected","distribution.fop.completed","fund.redemption.cancelled","fund.redemption.rejected","fund.redemption.requested","fund.redemption.settled","fund.subscription.cancelled","fund.subscription.rejected","fund.subscription.requested","fund.subscription.settled","issuer.created","issuer.updated","market.asset.halted","market.asset.unhalted","market.closed","market.halt.ended","market.halt.started","market.halted","market.initialized","market.listing.delisted","market.listing.halted","market.listing.listed","market.listing.order.cancelled","market.listing.order.expired","market.listing.order.filled","market.listing.order.opened","market.listing.order.rejected","market.listing.trade.executed","market.listing.unhalted","market.opened","market.updated","node.config.updated","otc-trade.fop.cancelled","otc-trade.fop.completed","otc-trade.fop.initiated","otc-trade.fop.rejected","supply-change.approved","supply-change.cancelled","supply-change.completed","supply-change.initiated","supply-change.rejected"],"description":"Type of event"}}}}
```

## The DefaultScale object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DefaultScale":{"type":"integer","format":"int64","const":6,"description":"Decimal exponent applied to integer-encoded values without a currency exponent (e.g. percentages). The real value equals `encoded × 10^-6`; e.g. 11% is encoded as 11000000."}}}}
```

## The DistributionType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"DistributionType":{"type":"string","enum":["fop","dvp"],"description":"**Type of distribution:**\n- `fop` - Free Of Payment: asset units are transferred for free\n- `dvp` - Delivery Versus Payment: asset units are transferred for an agreed currency amount"}}}}
```

## The ExponentScaledDecimal object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ExponentScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by the asset's exponent: `encoded = real × 10^exponent`. E.g. for a bond denominated in EUR (exponent=2), a coupon payment of `123.45` is encoded as `12345`, and a nominal value of `1000.00` is encoded as `100000`."}}}}
```

## The IncomeUse object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"IncomeUse":{"type":"string","enum":["accumulating","distributing"],"description":"**Income use policy of the fund:**\n- `accumulating` - income is reinvested into the fund's NAV\n- `distributing` - income is paid out to unit-holders"}}}}
```

## The InstrumentOrigin object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"InstrumentOrigin":{"type":"string","enum":["native","tokenized"],"description":"**Origin of the fund:**\n- `native` - fund originally issued on Axiology TSS\n- `tokenized` - immobilised external fund tokenised on Axiology TSS"}}}}
```

## The MmfVariant object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"MmfVariant":{"type":"string","enum":["CNAV","LVNAV","VNAV","Short-Term VNAV"],"description":"**Money Market Fund variant:**\n- `CNAV` - Constant Net Asset Value\n- `LVNAV` - Low-Volatility Net Asset Value\n- `VNAV` - Variable Net Asset Value\n- `Short-Term VNAV` - Short-Term Variable Net Asset Value"}}}}
```

## The PayoutType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PayoutType":{"type":"string","enum":["currency","units"],"description":"**How the fund pays out income:**\n- `currency` - paid out in the settlement currency\n- `units` - reinvested as fund units"}}}}
```

## The PriceNotation object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"PriceNotation":{"type":"string","enum":["MONE","PERC","YIEL","BAPO"],"description":"**ESMA-aligned price notation codes** (MiFIR RTS 2/22).\n- `MONE` - monetary per-unit amount.\n- `PERC` - percentage (e.g. percentage of nominal value).\n- `YIEL` - yield.\n- `BAPO` - basis points."}}}}
```

## The RedemptionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"RedemptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund redemption status:**\n- `requested` - redemption requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; cash delivered to the investor"}}}}
```

## The ScaledDecimal object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The SettlementMethod object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SettlementMethod":{"type":"string","enum":["on-chain","off-chain"],"description":"**Cash leg settlement method:**\n- `on-chain` - cash leg settles on-chain\n- `off-chain` - cash leg settles off-chain"}}}}
```

## The SubscriptionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"SubscriptionStatus":{"type":"string","enum":["requested","cancelled","rejected","settled"],"description":"**Fund subscription status:**\n- `requested` - subscription requested by the investor's broker agent\n- `cancelled` - cancelled by the investor's broker agent\n- `rejected` - rejected by the issuer agent\n- `settled` - settled by the issuer agent; units delivered to the investor"}}}}
```

## The TickSize object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"TickSize":{"allOf":[{"$ref":"#/components/schemas/ScaledDecimal"}],"format":"int64","enum":[100,200,500,1000,2000,5000,10000,20000,50000,100000,200000,500000,1000000,2000000,5000000,10000000,20000000,50000000,100000000,200000000,500000000],"description":"Permitted tick sizes (MiFID II RTS 11). E.g. `100` = `0.0001`, `10000` = `0.01`, `1000000` = `1`, `500000000` = `500`.\n\nScaled as `ScaledDecimal`."},"ScaledDecimal":{"type":"integer","format":"int64","description":"Decimal value encoded on the wire as an integer scaled by [DefaultScale](#/components/schemas/DefaultScale): `encoded = real × 10^6`. E.g. `11.0` is encoded as 11000000, `0.5` as 500000."}}}}
```

## The VehicleType object

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"components":{"schemas":{"VehicleType":{"type":"string","enum":["UCITS sub-fund","AIF","Securitisation compartment","Standalone fund"],"description":"**Vehicle type of the fund:**\n- `UCITS sub-fund` - sub-fund of a UCITS umbrella\n- `AIF` - alternative investment fund\n- `Securitisation compartment` - compartment of a securitisation vehicle\n- `Standalone fund` - standalone fund without an umbrella structure"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://axiology.gitbook.io/axiology-docs/rest-api/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.