Skip to main content
View as Markdown

Deposits list

This method allows retrieving the list of active deposits. No parameters are passed.

Response​

namestring

A deposit name or, if no name is set, a deposit type.

accountNostring

A deposit account number.

balancedecimal number

An amount on the deposit.

ratedecimal number

An annual interest rate.

agreeNostring

An agreement number.

maturityDatedate

A deposit maturity date.

startDatedate

A deposit opening date.

interestAccrueddecimal number

An accrued interest.

ccystring

A deposit currency.

depositTypestring

A deposit type.

nextWithdrawalDatedate

A date of the next interest accrual.

interestWithPeriodTypestring

An interest accrual periodicity.

accrualBalancedecimal number

A minimum amount on which the interest was accrued.

agreementsobject

Interest accrual ranges.

irrdecimal number

An internal rate of return.

ratedecimal number

An annual interest rate.

balancestring

An amount range as text.

GET api/deposits/agreements
[
  {
    "name": "sample string 1",
    "accountNo": "sample string 2",
    "balance": 1.0,
    "rate": 1.0,
    "agreeNo": "sample string 3",
    "maturityDate": "2026-06-10T07:17:56.690Z",
    "startDate": "2026-06-10T07:17:56.690Z",
    "interestAccrued": 1.0,
    "ccy": "sample string 4",
    "depositType": "sample string 5",
    "nextWithdrawalDate": "2026-06-10T07:17:56.690Z",
    "interestWithPeriodType": "sample string 6",
    "accrualBalance": 1.0,
    "agreements": [
      {
        "irr": 1.0,
        "rate": 1.0,
        "balance": "sample string 1"
      }
    ]
  }
]