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)
Deposit Account Servcies Term Deposit services Existing New GET endpoints released with PII changes
  • /service/v2/termdeposit/.search
  • /service/v2/termdeposit/aggregate/.search
  • /service/v2/termdeposit/getMemosNotesByAccNo/.search
  • /service/v2/termdepositbyacc/.search
/service/v1/termdeposit
  • calculateMaturityAmount flag added during deposit creation -> Flag to specify whether maturity amount calculation needs to be done or not.Supported Values : Y/N/D. Default value is 'D'.
  • BundleBenefitDetailsModel introduced within Deposit creation API.
  • Account level liquidation tags (liqnDays, liqnMonths, liqnYears) added within "interestDetailsMcy" data.
  • In "depositPayinDetails" - multimodePayopt, multimodeOffsetBrn are made mandatory.
  • AccountNomineeModel - accountNumber is mandatory /service/v1/tdMaturityComp/computeMaturityOnline

Account level liquidation tags (liqnDays, liqnMonths, liqnYears) and Bundle related fields (bundleRate,bundleExpiryDate, bundleId) added in payload.

Success response code changed to 200.

tdAmount is made mandatory

tdRateCode, mainIntUde tags introduced in response
Deposit Transaction Services Deposit Redemption Deposit Top-up Deposit Amount Block Existing /service/v1/deposit/tdTopUpvalidation , /service/v1/deposit/tdTopupcreate
  • planRefNo,finCycle added for IRA deposit cases
  • multimodeTdoffsetAcc is mandatory
  • interestLiquidationDetails model added in response
/service/v1/icdredmn/redemTdProcess
IRA related new payload fields - newIRATDAfterClosure, finCycle, planRefNo, planType
  • /service/v1/icdredmn/redemTdCreate,
  • /service/v1/icdredmn/redemTdValidation,
  • /service/v1/icdredmn/redemTdProcess

federalTax, stateTax, federalGl, stateGl instroduced in response.

Endpoints introduced as part of PII Changes:

/service/v2/tdamtblk/getByAccNo/.search
Deposit Enquiry Services Deposit Query Services Existing Endpoints introduced as part of PII Changes
  • /service/v2/queryResponseService/.search
  • /service/v2/eventEntries/.search
  • /service/v2/balanceQuery/.search
  • /service/v3/depositBalances/.search
  • /service/v2/interestTrnDetails/.search
Deposit Advices and Certificates Deposit Advices and Certificates Services Existing Removed this section and relocated to Deposit Integration Services
Deposit Integration Services Deposit Integration Services New
  • /service/v1/TDinput/custDetails/(custNo)
  • /service​/v1​/TDinput​/requestCertificate
  • /service/v1/TDinput/downloadCertificate/(certificateNo)
Deposit Maturity Calculation Services Endpoint to manually trigger calculation of maturity details for the deposit New ​/calculateMatcalc
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.

Banks can Create, Amend, close/re-open and enquire business Products through the UI of BA application or through Integration supported with this API by calling appropriate methods, PUT, POST, PATCH and GET the said API

 Existing /service/v1/accountclass

misDetails introduced in payload, response.
IRA Business Product Configuration Banks offering Deposit Services publish Individual Retirement Account business products to cater to different needs of Retail Customers. Oracle Banking Business Product REST API helps Banks to Create, Amend IRA Certificate of Deposit Products through Bank's in-house product composer/ workbench or though any 3rd Party application. IRA Business Products can be defined with set of configurable attributes to cater to the target market segments and also fullfill the Bank's promotional campaings New
  • /service/v1/iraproduct (GET, POST)
  • /service/v1/iraproduct/{keyId}
  • /service/v1/iraproduct/{keyId}/close
  • /service/v1/iraproduct/{keyId}/reopen
  • /service/v1/iraproduct/{keyId}/aggregate
IRA Deposit transaction services Endpoints for doing transactions for an IRA Deposit New
  • /ob/oba/iratxn/v1/contribution
  • /ob/oba/iratxn/v1/distribution
  • /ob/oba/iratxn/v1/balanceSummary/.search
  • /ob/oba/iratxn/v1/getValidAccounts/.search
  • /ob/oba/iratxn/v1/checkPenalty
Depositt Reversal Reversal of all the events associated with the deposit New /service/v1/reverseDeposit
Interest services Services associated with Interest related maintenances New Interest product APIs
  • /icProduct
  • /icProductsDetail
User Defined Element (UDE) List APIs

/prodUdeList

Interest Rate code APIs
  • /icdbrnav/rateCodeDetails
  • /icdbrnav (GET, POST , PUT)
Interest Rate Input APIs

/icRates (GET, OIST, PUT)

User Defined Element (UDE) Value Input APIs

/udeVals/genCondn (GET, POST, PUT)