1.2.4 API Enhancements for Retail Deposits Service

This topic provides details of incremental changes in ReSTful APIs for Retail Deposits.

Table 1-2 ReSTful APIs (enhancements/amendments) in Retail Deposits

API Name (as in Swagger) API Functional Description New API / Existing Brief of the Change(s)
API versioning changes API versioning changes 14.8.1.0.0. All the exposed APIs API versioning changes done across all the swagger endpoints to include v14.8.1.0.0 in the URL.
IRA Deposit Account Services This service is used to create IRA Deposit Accounts. New New endpoints:
  • POST /service/v14.8.1.0.0/iratermdeposit
  • POST /service/v14.8.1.0.0/iratermdeposit/validateTD
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositBcPayoutDetails
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositPayin
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositPayout
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositInterestDetails
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositRollOverDetails
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositAccountNominee
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositAccountGuardian
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositBasicDetails
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositAccountMis
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositAccountStatementPreferences
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositAccountAddress
  • PATCH /service/v14.8.1.0.0/iratermdeposit/termDepositEffectiveDate
  • PATCH /service/v14.8.1.0.0/iratermdeposit/accountProfitMaster
  • POST /service/v14.8.1.0.0/iraDepositSimulation
Deposit External Parameter Configuration The set of services are used for maintaining external parameters configuration. New New endpoints:
  • POST /service/v14.8.1.0.0/tdexternalparam
  • GET /service/v14.8.1.0.0/tdexternalparam
  • GET /service/v14.8.1.0.0/tdexternalparam/{resourceId}
  • GET /service/v14.8.1.0.0/tdexternalparam/{keyId}/aggregate
  • GET /service/v14.8.1.0.0/tdexternalparam/{keyId}
  • PUT /service/v14.8.1.0.0/tdexternalparam/{keyId}
  • PATCH /service/v14.8.1.0.0/tdexternalparam/{keyId}/close
  • PATCH /service/v14.8.1.0.0/tdexternalparam/{keyId}/reopen
  • PATCH /service/v14.8.1.0.0/tdexternalparam/{keyId}/aggregate
Deposit Business Product Services Business Products can be defined with set of configurable attributes to cater to the target market segments and fulfil the Bank's promotional campaigns. Existing
  1. New fields added
    New fields added
    • rolloverToDiffProd
    • targetProdRollover
    TdPreferencesModel
    • statementDueType
    • statementDueOnDate
    • zeroBalanceDeposit
    • zeroBalHoldDays
    • zeroBalPriorNoticeDays
    MinMaxModel
    • thresholdType
  2. ProductMappingModel -> productCode and currency are required fields.
Deposit Account Servcies Term Deposit services Existing
  1. TermDepositWebModel
    • New tag added "depositExternalFunding"
    • Removed tags - "denomDep", "dualCurrencyDepositDetails"
    • "tdAmount" is made non-mandatory (for zero balance cases)
    • In "accountMis", new tag "transactionMisDetails" is added.
  2. New endpoints added -
    • PATCH /service/v14.8.1.0.0/termDepositBasicDetails
    • PATCH /service/v14.8.1.0.0/termDepositPayout
    • PATCH /service/v14.8.1.0.0/termDepositPayin
    • PATCH /service/v14.8.1.0.0/termDepositAccountStatementPreferences
    • PATCH /service/v14.8.1.0.0/termDepositAccountAddress
    • PATCH /service/v14.8.1.0.0/termDepositInterestDetails
    • PATCH /service/v14.8.1.0.0/termDepositRollOverDetails
    • PATCH /service/v14.8.1.0.0/termDepositAccountMis
    • PATCH /service/v14.8.1.0.0/termDepositAccountNominee
    • PATCH /service/v14.8.1.0.0/termDepositAccountGuardian
    • PATCH /service/v14.8.1.0.0/termDepositJointHolder
    • PATCH /service/v14.8.1.0.0/termDepositPcPayoutDetails
    • PATCH /service/v14.8.1.0.0/termDepositBcPayoutDetails
    • PATCH /service/v14.8.1.0.0/termDepositEffectiveDate
    • PATCH /service/v14.8.1.0.0/termDepositAccountMemo
    • PATCH /service/v14.8.1.0.0/childTdPayout
    • PATCH /service/v14.8.1.0.0/accountProfitMaster
Deposit Penalty Parameter Configuration Endpoints for penalty parameter configurations Existing Correction done in payload of /service/v14.8.1.0.0/tdpenaltybasis - In TdPenaltyBasisModel , TdPenaltyDaysMappingModel is added.
Deposit Reversal Endpoints for Deposit reversal Existing New endpoint added - /service/v14.8.1.0.0/reverseTransaction
Redemption Redemption endpoints Existing Payload changes

In icdredmnDetailsModel -> TdredmpayoutDetailsModel , new tag "externalFunding" is added.

Top-up Deposit Top-up endpoints Existing
  1. In DepositRequestDTO, removed tags
    • "planRefNo"
    • "finCycle"
  2. In TDPayinDto, removed tags
    • "fcyAmount"
    • "originalExchangeRate"
    • "appliedExchangeRate"
    • "seqno"
    • "referenceNo"
Deposit Enquiry Services This service is used to query the details of Deposit Accounts, Business Products and Payin Maintenances Existing
  1. New APIs added
    • /service/v14.8.1.0.0/glQuery/.search
  2. In queryResponseModel, new tags added
    • "jointHolder"
    • "accountMis"
    • "ictmPCPayoutDetailCollection"
    • "ictmBCPayoutDetailCollection"
Statement Generation This service is used to generate and download statements New ​/POST /service/v1/accStatement

GET /service/v1/accStatement

POST /service/v1/accnconsolidatedstatement  

GET /service/v1/accStatement/download/{referenceNo}

Parent topic: Release Enhancements