Accounts

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/accounts/{accountAddress}/deposits

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/deposits HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T04:36:57.481Z",
      "updatedAt": "2025-12-14T04:36:57.481Z",
      "id": "b18c0893-f86b-4477-a267-7b46d623be72",
      "brokerId": "669ed9a5-1ff4-41d4-9214-a28d0df194c4",
      "currencyId": "9d28e972-6028-4355-a800-c392a1a2384e",
      "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "iban": "LT601010012345678901",
      "amount": 10000,
      "status": "deposited",
      "transactionId": "123456789012345678",
      "correlationId": "b18c0893-f86b-4477-a267-7b46d623be72"
    }
  ]
}

Get account's withdrawals

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/accounts/{accountAddress}/withdrawals

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/withdrawals HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T04:36:57.481Z",
      "updatedAt": "2025-12-14T04:36:57.481Z",
      "id": "3d152bdd-1ec8-4bb0-93c8-def401747014",
      "brokerId": "d449e186-da32-4e0e-b418-66a0c646403e",
      "currencyId": "84ffdd88-db29-4e44-b081-0a31235bbf47",
      "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "iban": "LT601010012345678901",
      "amount": 10000,
      "status": "withdrawn",
      "transactionId": "123456789012345678",
      "correlationId": "3d152bdd-1ec8-4bb0-93c8-def401747014"
    }
  ]
}

get

Retrieve a list of accounts available in the system

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:

orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, type, status

Responses

200

Successfully retrieved a list of items.

application/json

get

/accounts

HTTPcURLJavaScriptPython

GET /accounts HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T04:36:57.481Z",
      "updatedAt": "2025-12-14T04:36:57.481Z",
      "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
      "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "type": "investor",
      "institutionSectorCode": "S.11",
      "walletType": "client-individual",
      "status": "active",
      "openedAt": "2025-12-14T04:36:57.481Z"
    }
  ]
}

post

Create a new investor account.

Body

application/json

institutionSectorCodeall ofRequired

Institutional Sector Code from 2010 ESA Standards

Example: S.125

string · enumOptional

Institutional Sector Code from 2010 ESA Standards

Possible values:

walletTypeall ofRequired

Indicates that funds are owned by either broker or client

Example: client-individual

string · enumOptional

Indicates that funds are owned by either broker or client

Possible values:

Responses

201

Created investor account

application/json

post

/accounts

HTTPcURLJavaScriptPython

POST /accounts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "institutionSectorCode": "S.125",
  "walletType": "client-individual"
}

201

Created investor account

{
  "createdAt": "2025-12-14T04:36:57.481Z",
  "updatedAt": "2025-12-14T04:36:57.481Z",
  "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "type": "investor",
  "institutionSectorCode": "S.11",
  "walletType": "client-individual",
  "status": "active",
  "openedAt": "2025-12-14T04:36:57.481Z"
}

get

Get specific account information in the system

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Responses

200

Found account

application/json

get

/accounts/{accountAddress}

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress} HTTP/1.1
Host: 
Accept: */*

200

Found account

{
  "createdAt": "2025-12-14T04:36:57.481Z",
  "updatedAt": "2025-12-14T04:36:57.481Z",
  "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "type": "investor",
  "institutionSectorCode": "S.11",
  "walletType": "client-individual",
  "status": "active",
  "openedAt": "2025-12-14T04:36:57.481Z"
}

delete

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Responses

200

Deleted investor account

application/json

delete

/accounts/{accountAddress}

HTTPcURLJavaScriptPython

DELETE /accounts/{accountAddress} HTTP/1.1
Host: 
Accept: */*

200

Deleted investor account

{
  "createdAt": "2025-12-14T04:36:57.481Z",
  "updatedAt": "2025-12-14T04:36:57.481Z",
  "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "type": "investor",
  "institutionSectorCode": "S.11",
  "walletType": "client-individual",
  "status": "active",
  "openedAt": "2025-12-14T04:36:57.481Z"
}

patch

Update investor specific account information in the system

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Body

application/json

statusall ofOptional

Freeze/unfreeze account:

• frozen - freeze account
• active - unfreeze account

Example: frozen

string · enumOptional

Status of the account:

• active - account is allowed to interact with the system
• frozen - no assets can be moved around
• deleted - no further actions can be done

Possible values:

Responses

200

Updated investor account

application/json

patch

/accounts/{accountAddress}

HTTPcURLJavaScriptPython

PATCH /accounts/{accountAddress} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "frozen"
}

200

Updated investor account

{
  "createdAt": "2025-12-14T04:36:57.481Z",
  "updatedAt": "2025-12-14T04:36:57.481Z",
  "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "type": "investor",
  "institutionSectorCode": "S.11",
  "walletType": "client-individual",
  "status": "active",
  "openedAt": "2025-12-14T04:36:57.481Z"
}

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

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

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/bonds/maturity/payments HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

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

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

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

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/bonds/coupon-payments HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T04:36:57.481Z",
      "updatedAt": "2025-12-14T04:36:57.481Z",
      "id": "89ea2b89-a686-4474-87fd-8316d65edff8",
      "status": "paid",
      "receiverAddress": "r49wKDuk5e7oZNHiY5GtwBeAo7ioGoxoH",
      "bondAmount": 100000,
      "payoutAmount": 1000,
      "couponId": "464be2d3-bdf5-4075-9d92-badb6be202a1"
    }
  ]
}

Deprecated

get

Retrieve a paginated list of account's bond distributions

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/accounts/{accountAddress}/bonds/distributions

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/bonds/distributions HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T04:36:57.481Z",
      "updatedAt": "2025-12-14T04:36:57.481Z",
      "id": "30139970-74c9-4bd7-813a-4449ec5553bb",
      "bondId": "1735c7a7-1709-4524-b95a-3c91c9caf338",
      "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "amount": 1000,
      "price": 900,
      "status": "proposed"
    }
  ]
}

Deprecated

patch

Manually retry bond distribution, when failed due to account

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

distributionIdstring · uuidRequired

Distribution UUID identifier, unique in scope of this node

Example: ec6d56d5-7aba-4cfe-8daa-ce54570e406c

Responses

200Success

application/json

patch

/accounts/{accountAddress}/bonds/distributions/{distributionId}

HTTPcURLJavaScriptPython

PATCH /accounts/{accountAddress}/bonds/distributions/{distributionId} HTTP/1.1
Host: 
Accept: */*

200Success

{
  "createdAt": "2025-12-14T04:36:57.481Z",
  "updatedAt": "2025-12-14T04:36:57.481Z",
  "id": "30139970-74c9-4bd7-813a-4449ec5553bb",
  "bondId": "1735c7a7-1709-4524-b95a-3c91c9caf338",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "amount": 1000,
  "price": 900,
  "status": "proposed"
}

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

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

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/otc-trades-dvp HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T04:36:57.481Z",
      "updatedAt": "2025-12-14T04:36:57.481Z",
      "id": "c1f5a632-e1b6-40ee-9fff-7b3b6914c218",
      "status": "initiated",
      "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "initiatorSendAssetId": "7abc300c-8793-497f-b72a-0849f67735d2",
      "initiatorSendAmount": 200,
      "initiatorBrokerId": "6172395e-c878-447d-91a8-857c7c107bd4",
      "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "acceptorSendAssetId": "97ff8db4-d3e4-4c8f-a921-2e2ef8f32025",
      "acceptorSendAmount": 100,
      "acceptorBrokerId": "503ca9a3-1871-48fb-95fc-f057c12dbb70",
      "tradedAt": "2025-12-14T04:36:57.481Z"
    }
  ]
}

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

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

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/otc-trades-fop HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T04:36:57.481Z",
      "updatedAt": "2025-12-14T04:36:57.481Z",
      "id": "9b34abf5-e655-40de-a98e-0bd1976294a3",
      "status": "initiated",
      "assetId": "75e53a88-676a-4e53-bd3f-3b937a370075",
      "amount": 200,
      "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "initiatorBrokerId": "abe4fba9-f445-4190-ad6e-0971b14be4aa",
      "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "acceptorBrokerId": "62168fde-45f7-48ef-a67a-35b15cfd34a1",
      "reason": "internal",
      "tradedAt": "2025-12-14T04:36:57.481Z"
    }
  ]
}

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/accounts/{accountAddress}/bonds

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/bonds HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "bond": {
        "createdAt": "2025-12-14T04:36:57.481Z",
        "updatedAt": "2025-12-14T04:36:57.481Z",
        "id": "9183411b-229c-45b7-a258-572ac8f32c01",
        "issuerId": "dc5aaf42-d279-41d5-badf-e375803dde06",
        "currencyId": "5e63fa7d-34e9-4c3f-aa7c-cb8d9aed5cc8",
        "brokerId": "205e9ff3-6de2-4fd6-9831-06feccb9e63c",
        "origin": "native",
        "custodian": "Custodian Bank",
        "custodianLeiCode": "DG3RU1DBUFHT4ZF9WN62",
        "issuerCsdLeiCode": "DG3RU1DBUFHT4ZF9WN62",
        "csdRegisteredAt": "2034-12-30T00:00:00.000Z",
        "underlyingInstrumentCode": "US0378331005",
        "fisn": "FUTURETECH/COMMON STOCK",
        "countryCode": "LT",
        "turnoverType": "public",
        "seniority": "senior-debt",
        "status": "closed",
        "initialPlacement": "public",
        "issuingAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
        "operationalAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
        "isin": "US0378331005",
        "cfi": "DBVUGR",
        "figi": "BBG000BLNNV0",
        "ticker": "AAPL",
        "dti": "BCDFGHJK9",
        "issuePrice": "20 000 USD",
        "nominalValue": 10,
        "totalNominalValue": 10000,
        "interestRate": "10",
        "interestType": "fixed",
        "interestBase": "act365",
        "interestInterval": "annual",
        "settlementUnitMultiple": 2,
        "minimumSettlementUnit": 2,
        "prospectusRegistered": true,
        "preEmptiveRights": true,
        "earlyRedemption": true,
        "secured": true,
        "securedBacking": "Gold",
        "issuedAt": "2034-12-30T00:00:00.000Z",
        "issuanceRecordAt": "2034-12-30T00:00:00.000Z",
        "settleAt": "2034-12-30T00:00:00.000Z",
        "maturityRecordAt": "2034-12-30T00:00:00.000Z",
        "matureAt": "2034-12-30T00:00:00.000Z",
        "distributedAmount": 1000,
        "requestedAmount": 1000,
        "collectedAmount": 1000,
        "name": "BOND",
        "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
        "exponent": 0,
        "supply": 1000,
        "totalSupply": 1000,
        "couponIds": [
          "36dbd1cc-cc4a-43d0-a166-e3e4cd1380f7"
        ],
        "maturityPaymentIds": [
          "888431dc-1d81-4f6b-9131-475f8d3ee0f8"
        ],
        "distributionIds": [
          "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
        ],
        "supplyChangeIds": [
          "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
        ],
        "dataValidationIds": [
          "2c978a1a-e7c0-4cc3-a401-6a9bb7c2441f"
        ],
        "settlementType": "external"
      },
      "amount": 10000,
      "reservedAmount": 1000
    }
  ]
}

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/accounts/{accountAddress}/currencies

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/currencies HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "currency": {
        "createdAt": "2025-12-14T04:36:57.481Z",
        "updatedAt": "2025-12-14T04:36:57.481Z",
        "id": "f6bb6c1e-047d-4166-bf06-e8d5f4edd014",
        "name": "Euro",
        "code": "EUR",
        "exponent": 0,
        "supplyLimit": 1000000000,
        "issuingAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
        "operationalAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"
      },
      "amount": 10000,
      "reservedAmount": 1000
    }
  ]
}

get

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

Path parameters

accountAddressstring · xrp-addressRequired

Account address

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

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/accounts/{accountAddress}/equities

HTTPcURLJavaScriptPython

GET /accounts/{accountAddress}/equities HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "equity": {
        "createdAt": "2025-12-14T04:36:57.481Z",
        "updatedAt": "2025-12-14T04:36:57.481Z",
        "id": "acd9090d-dc68-45b1-8192-b21feb596f6d",
        "currencyId": "61d68b4b-80ca-4998-8851-87eac97c4acd",
        "issuerId": "a0308c1f-1bad-439d-8d48-3c3c0804669f",
        "nominalValue": 10000,
        "issueDate": "2024-05-09T10:00:00.000Z",
        "status": "recorded",
        "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
        "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
        "name": "UAB Trys Gaideliai nematerialios akcijos",
        "supply": 5000000,
        "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
        "isin": "US4592001014",
        "undistributedAmount": 2000
      },
      "amount": 10,
      "reservedAmount": 5
    }
  ]
}