ResponseWrapperTermDepositDto

Wrapper for the response containing the result of a term deposit.

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS

messagestring

Message describing the response

Example: Request failed/Request successful

codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001

data object

DTO representing the details of a term deposit.

idstring

The unique identifier of the term deposit.

Example: 123456

subscriptionAccountstring

The associated subscription account.

Example: ABCD1234

associatedBankCodestring

The associated bank code.

Example: 001

depositAccountstring

The term deposit account.

Example: XYZ987

currencystring

The currency of the deposit.

Example: EUR

typestring

The type of the term deposit.

Example: Standard

indexedboolean

Indicates if the deposit is indexed.

Example: true

pledgedstring

Indicates if the deposit is pledged.

Example: false

statusCodestring

The status code of the deposit.

Example: ACTIVE

currencyLabelstring

Currency label.

Example: Euro

periodicityLabelstring

Periodicity label of the deposit.

Example: Monthly

renewalModeLabelstring

Renewal mode label.

Example: Automatic

subscriptionAccountIdint64

The subscription account ID.

Example: 10001

interestPaymentAccountIdint64

The interest payment account ID.

Example: 20002

depositAccountIdint64

The deposit account ID.

Example: 30003

versionint64

Version of the deposit.

Example: 1

depositAmountnumber

The amount of the term deposit.

Example: 100000

depositAmountFormattedstring

Formatted amount of the term deposit.

Example: 100,000.00 EUR

interestRatedouble

The interest rate of the term deposit.

Example: 2.5

fundOriginstring

The origin of the funds.

Example: Internal

executionDatestring

The execution date of the deposit.

Example: 2025-01-01

effectDatestring

The effect date of the deposit.

Example: 2025-01-02

maturityDatestring

The maturity date of the deposit.

Example: 2025-12-31

periodicitystring

Periodicity of the deposit.

Example: Annually

prepaidInterestboolean

Indicates if interest is prepaid.

Example: false

capitalizationboolean

Indicates if the deposit is capitalized.

Example: true

exemptFromWithholdingTaxboolean

Indicates if withholding tax is exempted.

Example: false

daysCountint32

Number of days associated with the deposit.

Example: 365

renewalModestring

Renewal mode of the deposit.

Example: Automatic

grossAnnualYieldRatedouble

The gross annual yield rate of the deposit.

Example: 3.5

interestPaymentAccountstring

The account where interest will be paid.

Example: ABC123

statusstring

The status of the term deposit.

Example: ACTIVE

numberstring

The number of the term deposit.

Example: 987654

typeLabelstring

The type label of the term deposit.

Example: Term Deposit

agencystring

The agency associated with the deposit.

Example: Agency A

interestTypestring

The type of interest applied to the deposit.

Example: Fixed

interestTypeLabelstring

The label of the interest type.

Example: Fixed Rate

durationInMonthsstring

The duration of the deposit in months.

Example: 24

rootstring

The root of the account.

Example: DEPOSIT-123

maxAmountnumber

The maximum allowed deposit amount.

Example: 1000000

minAmountnumber

The minimum allowed deposit amount.

Example: 1000

startDatestring

The start date of the deposit.

Example: 2025-01-01

endDatestring

The end date of the deposit.

Example: 2025-12-31

interestAmountnumber

The amount of interest.

Example: 500

depositRatedouble

The deposit rate for the term deposit.

Example: 2.5

interestAmountFormattedstring

Formatted interest amount.

Example: 500.00 EUR

rateFormattedstring

Formatted deposit rate.

Example: 2.5%

advanceboolean

Indicates if an advance is allowed on the deposit.

Example: false

advanceAmountnumber

The amount of the allowed advance.

Example: 20000

error object

Detailed information about the error response

codestring

Error code

Example: ERR-142

messagestring

Error message

Example: Resource not found / Internal server error

details object[]

List of error details

Array [

codestring

Error code

Example: ER4001

messagestring

Detailed error message

Example: Invalid input

targetstring

Target of the error

Example: username

]

suggestionsstring[]

List of suggestions for resolving the error

Example: ["Check the resource ID","Ensure the resource exists"]

metaData object

Additional metadata about the error, that could help in debugging

property name*string

Additional metadata about the error, that could help in debugging

Example: {"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}

timestampdate-time

Timestamp of when the response was generated

ResponseWrapperTermDepositDto

{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": {
    "id": "123456",
    "subscriptionAccount": "ABCD1234",
    "associatedBankCode": "001",
    "depositAccount": "XYZ987",
    "currency": "EUR",
    "type": "Standard",
    "indexed": true,
    "pledged": "false",
    "statusCode": "ACTIVE",
    "currencyLabel": "Euro",
    "periodicityLabel": "Monthly",
    "renewalModeLabel": "Automatic",
    "subscriptionAccountId": 10001,
    "interestPaymentAccountId": 20002,
    "depositAccountId": 30003,
    "version": 1,
    "depositAmount": 100000,
    "depositAmountFormatted": "100,000.00 EUR",
    "interestRate": 2.5,
    "fundOrigin": "Internal",
    "executionDate": "2025-01-01",
    "effectDate": "2025-01-02",
    "maturityDate": "2025-12-31",
    "periodicity": "Annually",
    "prepaidInterest": false,
    "capitalization": true,
    "exemptFromWithholdingTax": false,
    "daysCount": 365,
    "renewalMode": "Automatic",
    "grossAnnualYieldRate": 3.5,
    "interestPaymentAccount": "ABC123",
    "status": "ACTIVE",
    "number": "987654",
    "typeLabel": "Term Deposit",
    "agency": "Agency A",
    "interestType": "Fixed",
    "interestTypeLabel": "Fixed Rate",
    "durationInMonths": "24",
    "root": "DEPOSIT-123",
    "maxAmount": 1000000,
    "minAmount": 1000,
    "startDate": "2025-01-01",
    "endDate": "2025-12-31",
    "interestAmount": 500,
    "depositRate": 2.5,
    "interestAmountFormatted": "500.00 EUR",
    "rateFormatted": "2.5%",
    "advance": false,
    "advanceAmount": 20000
  },
  "error": {
    "code": "ERR-142",
    "message": "Resource not found / Internal server error",
    "details": [
      {
        "code": "ER4001",
        "message": "Invalid input",
        "target": "username"
      }
    ],
    "suggestions": [
      "Check the resource ID",
      "Ensure the resource exists"
    ],
    "metaData": {
      "requestId": "3c5e4cebf39cbc5b",
      "operationId": "66fd4d2ae6b6"
    }
  },
  "timestamp": "2024-07-29T15:51:28.071Z"
}