> 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/accounts.md).

# Accounts

## GET /accounts/{accountAddress}/deposits

> Get a paginated list of account's currency deposits information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/deposits":{"get":{"description":"Get a paginated list of account's currency deposits information in the system","operationId":"getAccountDeposits","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DepositDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"components":{"schemas":{"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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"}}}}
```

## Get account's withdrawals

> Get a paginated list of account's currency withdrawals information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/withdrawals":{"get":{"description":"Get a paginated list of account's currency withdrawals information in the system","operationId":"getAccountWithdrawals","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/WithdrawalDto"}}},"required":["pagination","items"]}}}}},"summary":"Get account's withdrawals","tags":["Accounts"]}}},"components":{"schemas":{"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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"}}}}
```

## GET /accounts

> Retrieve a list of accounts available in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts":{"get":{"description":"Retrieve a list of accounts available in the system","operationId":"getAccounts","parameters":[{"name":"filter","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/FilterAccountDto"}},{"name":"mode","required":false,"in":"query","description":"Strategy applied when filtering/searching on multiple fields","schema":{"$ref":"#/components/schemas/FilterMode"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}},{"name":"order","required":false,"in":"query","content":{"application/json":{"schema":{"type":"array","uniqueItems":true,"items":{"type":"object","oneOf":[{"properties":{"createdAt":{"type":"string","enum":["asc","desc"]}},"required":["createdAt"]},{"properties":{"type":{"type":"string","enum":["asc","desc"]}},"required":["type"]},{"properties":{"status":{"type":"string","enum":["asc","desc"]}},"required":["status"]},{"properties":{"openedAt":{"type":"string","enum":["asc","desc"]}},"required":["openedAt"]}]}}}},"description":"Array of fields and directions to order. Supported fields: createdAt, type, status, openedAt"}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"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"},"FilterMode":{"type":"string","enum":["and","or"]},"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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"]}}}}
```

## POST /accounts

> Create a new investor account.

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts":{"post":{"description":"Create a new investor account.","operationId":"createAccount","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountDto"}}}},"responses":{"201":{"description":"Created investor account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDto"}}}}},"summary":"","tags":["Accounts"]}}},"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"},"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"},"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"}}}}
```

## GET /accounts/{accountAddress}

> Get specific account information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}":{"get":{"description":"Get specific account information in the system","operationId":"getAccount","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}}],"responses":{"200":{"description":"Found account","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AccountDto"},{"$ref":"#/components/schemas/BasicAccountDto"}]}}}}},"summary":"","tags":["Accounts"]}}},"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"},"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"]}}}}
```

## DELETE /accounts/{accountAddress}

> Changes investor account status to deleted and disables account in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}":{"delete":{"description":"Changes investor account status to deleted and disables account in the system","operationId":"deleteAccount","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}}],"responses":{"200":{"description":"Deleted investor account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDto"}}}}},"summary":"","tags":["Accounts"]}}},"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"}}}}
```

## PATCH /accounts/{accountAddress}

> Update investor specific account information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}":{"patch":{"description":"Update investor specific account information in the system","operationId":"updateAccount","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountDto"}}}},"responses":{"200":{"description":"Updated investor account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDto"}}}}},"summary":"","tags":["Accounts"]}}},"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"},"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"}}}}
```

## GET /accounts/{accountAddress}/bonds/maturity/payments

> Get a paginated list of maturity payments' information in the system associated with provided account

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/bonds/maturity/payments":{"get":{"description":"Get a paginated list of maturity payments' information in the system associated with provided account","operationId":"getMaturityPayments","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/MaturityPaymentDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"components":{"schemas":{"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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`."}}}}
```

## GET /accounts/{accountAddress}/bonds/coupon-payments

> Get a paginated list of coupon payments' information in the system associated with provided account

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/bonds/coupon-payments":{"get":{"description":"Get a paginated list of coupon payments' information in the system associated with provided account","operationId":"getInvestorsCouponPayments","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CouponPaymentDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"components":{"schemas":{"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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`."}}}}
```

## GET /accounts/{accountAddress}/otc-trades-dvp

> Retrieve a list of OTC DVP Trade available in the system where account address is involved

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/otc-trades-dvp":{"get":{"description":"Retrieve a list of OTC DVP Trade available in the system where account address is involved","operationId":"getAccountOtcTradesDvp","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OtcTradeDvpDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"components":{"schemas":{"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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`."}}}}
```

## GET /accounts/{accountAddress}/otc-trades-fop

> Retrieve a list of OTC FOP Trade available in the system where account address is involved

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/otc-trades-fop":{"get":{"description":"Retrieve a list of OTC FOP Trade available in the system where account address is involved","operationId":"getAccountOtcTradesFop","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OtcTradeFopDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"components":{"schemas":{"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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"}}}}
```

## GET /accounts/{accountAddress}/bonds

> Get a paginated list of account's bond information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/bonds":{"get":{"description":"Get a paginated list of account's bond information in the system","operationId":"getAccountBonds","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"query","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/QueryAccountBondDto"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountBondBalanceDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"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)"}}},"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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."}}}}
```

## GET /accounts/{accountAddress}/currencies

> Get a paginated list of account's currencies information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/currencies":{"get":{"description":"Get a paginated list of account's currencies information in the system","operationId":"getAccountCurrencies","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"query","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/QueryAccountCurrencyDto"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountCurrencyBalanceDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"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)"}}},"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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`."}}}}
```

## GET /accounts/{accountAddress}/equities

> Get a paginated list of account's equity information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/equities":{"get":{"description":"Get a paginated list of account's equity information in the system","operationId":"getAccountEquities","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"query","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/QueryAccountEquityDto"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountEquityBalanceDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"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)"}}},"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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."}}}}
```

## GET /accounts/{accountAddress}/funds

> Get a paginated list of account's fund information in the system

```json
{"openapi":"3.1.0","info":{"title":"Axiology TSS Broker Node API","version":"0.0.1"},"paths":{"/accounts/{accountAddress}/funds":{"get":{"description":"Get a paginated list of account's fund information in the system","operationId":"getAccountFunds","parameters":[{"name":"accountAddress","required":true,"in":"path","description":"Account address","schema":{"format":"xrp-address","pattern":"r[0-9a-zA-Z]{24,34}","type":"string"}},{"name":"query","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/QueryAccountFundDto"}},{"name":"pagination","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/PaginationRequestDto"}}],"responses":{"200":{"description":"Successfully retrieved a list of items.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountFundBalanceDto"}}},"required":["pagination","items"]}}}}},"summary":"","tags":["Accounts"]}}},"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)"}}},"PaginationRequestDto":{"type":"object","properties":{"size":{"type":"number","minimum":1,"default":10},"page":{"type":"number","minimum":1,"default":1}}},"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"]},"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"}}}}
```


---

# 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/accounts.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.