1.2.7 API Enhancements for Retail Deposits Service

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

  • All the existing ReST APIs nomenclature has been modified to support Versioning for upcoming changes.

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 Transfer This service is used to perform Transfer From One Deposit to Another New
New Endpoints
  • POST /service/v14.8.2.0.0/depositTransfer/depositTransferValidate
  • POST /service/v14.8.2.0.0/depositTransfer/depositTransferCreate
Deposit Notice Configuration This set of services is used to perform online Initial Funding operation. New New Endpoints:
  • POST /service/v14.8.2.0.0/tdnoticeconfig
  • GET /service/v14.8.2.0.0/tdnoticeconfig
  • PUT /service/v14.8.2.0.0/tdnoticeconfig/{keyId}
  • PATCH /service/v14.8.2.0.0/tdnoticeconfig/{keyId}/close
  • PATCH /service/v14.8.2.0.0/tdnoticeconfig/{keyId}/reopen
  • GET /service/v14.8.2.0.0/tdnoticeconfig/{keyId}/aggregate
ESA Deposit Account Services This service is used to create ESA Deposit Accounts New New Endpoints:
  • POST /service/v14.8.2.0.0/tdnoticeconfig
  • GET /service/v14.8.2.0.0/tdnoticeconfig
  • PUT /service/v14.8.2.0.0/tdnoticeconfig/{keyId}
  • PATCH /service/v14.8.2.0.0/tdnoticeconfig/{keyId}/close
  • PATCH /service/v14.8.2.0.0/tdnoticeconfig/{keyId}/reopen
  • GET /service/v14.8.2.0.0/tdnoticeconfig/{keyId}/aggregate
  • POST /service/v14.8.2.0.0/esaTermDeposit
  • PUT /service/v14.8.2.0.0/esaTermDeposit/{accountNumber}
  • POST /service/v14.8.2.0.0/esaDepositSimulation
  • POST /service/v14.8.2.0.0/esaTermDeposit/validateTD
  • GET /service/v14.8.2.0.0/esaTermDepositbyacc
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositBasicDetails
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositPayout
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositPayin
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositAccountStatementPreferences
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositAccountAddress
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositInterestDetails
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositRollOverDetails
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositAccountMis
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositAccountNominee
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositAccountGuardian
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/accountProfitMaster
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositEffectiveDate
  • PATCH /service/v14.8.2.0.0/esaTermDeposit/termDepositAccountMemo
ESA Transaction Service This service is used to post ESA transactions New New Endpoints:
  • POST /service/v14.8.2.0.0/esa/contribution
  • POST /service/v14.8.2.0.0/esa/distribution
  • POST /service/v14.8.2.0.0/esa/balanceSummary/.search
  • POST /service/v14.8.2.0.0/esa/getValidAccounts/.search
  • POST /service/v14.8.2.0.0/esaTransfer
  • POST /service/v14.8.2.0.0/esaRollover
  • POST /service/v14.8.2.0.0/esa/checkPenalty
  • POST /service/v14.8.2.0.0/esa/accEnquiry/.search
Deposit ESA Product Configuration Deposit ESA Product Configuration New New Endpoints:
  • POST /service/v14.8.2.0.0/esaproduct
  • GET /service/v14.8.2.0.0/esaproduct
  • PUT /service/v14.8.2.0.0/esaproduct/{keyId}
  • PATCH /service/v14.8.2.0.0/esaproduct/{keyId}/close
  • PATCH /service/v14.8.2.0.0/esaproduct/{keyId}/reopen
  • GET /service/v14.8.2.0.0/esaproduct/{keyId}/aggregate
Reverse payment with failed status The service is used to reverse payment with failed status New New Endpoints:
  • POST /service/v14.8.2.0.0/transactionRetry
  • POST /service/v14.8.2.0.0/reverseTransactionByBranch
IRA Transaction Service IRA Transaction Service to post contributions and distributions, can also be used to check customer level balance, and used for IRA Transfer and Rollover from Debit Account to Credit Account Existing
  1. Description changes
  2. New fields in headers - idempotencyKey, idempotencyRetry, idempotencyRequestSource
  3. Deprecated APIs /service/v14.8.1.0.0/checkPenalty
  4. New APIs
    • POST /service/v14.8.2.0.0/checkPenalty
    • POST /service/v14.8.2.0.0/iraTransfer
    • POST /service/v14.8.2.0.0/iraRollover
    • POST /service/v14.8.2.0.0/accEnquiry/.search
    • POST /service/v14.8.2.0.0/paymentAccountDetails/.search
  5. IraTxnReqModel
    • Fields added - employerContribution, depositRedemIntPayout, depositDistributionMethod, trusteeToTrusteeTransfer, waiveRedmPenalty, waiveReason
    • Fields removed - eaRefNo
  6. IraTxnValidAccountsModel
    • Fields added - inheritedIra, is Closed
  7. TaxPerFyModel
    • Fields added - currentYear, rmdInfo
  8. TaxPerFyModel
    • Fields added - currency (mandatory)
Deposit Business Product Services Banks offering Deposit Services publish business products to cater to different needs of Retail Customers. Deposits are the most common products, along with Savings and Checking. Oracle Banking Business Product REST API helps Banks to Create, Amend Products through Bank's in-house product composer/ workbench or though any 3rd Party application. 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,Existing
  1. Versioning changes for endpoints -
    • - /service/v14.8.2.0.0/accountclass [ POST ]
    • - /service/v14.8.2.0.0/accountclass/{keyId} [ PUT ]
    • - /service/v14.8.2.0.0/accountclass/{keyId}/aggregate [GET]

    Changes -

    Fields removed -

    • Within TdMaturityInstructionsModel - matNoticePeriod
    • Within TdPreferencesModel - zeroBalPriorNoticeDays
  2. Description changes, spelling corrections.
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,Existing
  1. Versioning changes for endpoints -
    • - /service/v14.8.2.0.0/iraproduct [ POST ]
    • - /service/v14.8.2.0.0/iraproduct/{keyId} [ PUT ]
    • - /service/v14.8.2.0.0/iraproduct/{keyId}/aggregate [GET]

    Changes -

    Fields removed -

    • Within TdMaturityInstructionsModel - matNoticePeriod
    • Within TdPreferencesModel - zeroBalPriorNoticeDays
  2. Description changes, spelling corrections.
IRA Term Deposit Services This service is used to create IRA Deposit Accounts Existing
  1. Description and spelling changes.
  2. Header changes - included fields idempotencyKey, idempotencyRetry, idempotencyRequestSource
  3. BcPayoutDetailsModel
    • Fields added - refNo,scode,xref,micrNo,xrate,wavePenalty,charges,otherdets,countryCode,chqPercent
  4. PcPayoutDetailsModel
    • Fields added - action,autoAuth,checkerRemarks,makerRemarks,benfadd1,benfadd2,otherdets,custbankcode (read-only)
  5. TermDepositWebModel
    • Fields made mandatory - iraAccountDetails,interestDetails, udeCurrency & open tags made mandatory within interestDetails
    • Fields added - isContribution,errors
    • Fields removed - depositExternalFunding
  6. RolloverDetailsModel
    • Fields added - thresholdPayoutAcc
  7. AddlPayinDtilsModel
    • Fields added - id,parentId,referenceNo,mulitmodeXrate,seqno,chqInstrumentNo,draweeAcNo,routingNo,externalFunding,networkCode,instrumentCode,instrumentAmt,instrumentCcy,nachaTxnCode,benfName,narrative,instructionDate,chqInstrumentDate(read-only)
  8. IraAccountDetailsModel
    • Fields added - inheritedIra,iraInheritedAccountDetail
  9. IRATermDepositBasicDetailsModel
    • Fields added - iraCode2, employerContribution
  10. DepositPayoutDetailsModel
    • Fields added
    • version,resourceId,resourceModNo,datasegmentCode,delFlag,modificationStatus,makerId,makerDateStamp,makerUTC,makerBranch,makerTimeZone,checkerId,checkerDateStamp,checkerUTC,checkerBranch,checkerTimeZone,authStatus
  11. AccountStatementPreferencesModel
    • AccountStatementPreferencesModel
    • primaryISOStatReq,primaryISOMsgType,secondaryISOStatReq,secondaryISOMsgType,secondaryDueType,tertiaryDueType,secondaryDueOnDate,secondaryDueYear,tertiaryDueOnDate,tertiaryDueYear,accountStatementPreferencesMcy
  12. New endpoints added - PUT /service/v14.8.1.0.0/iratermdeposit/{accountNumber}, GET /service/v14.8.1.0.0/iratermdepositbyacc
  13. Models removed - DepositExternalFundingModel, interestStatment (within AccountStatementPreferencesModel)
  14. AccountMisModel
    • Fields added - compositeMisDetails
  15. TransactionMisDetailsModel
    • Fields added - transactionMisId,misRefNo
  16. Endpoints removed/deprecated
    • /service/v14.8.1.0.0/iratermdeposit/termDepositPayin [PATCH]
    • /service/v14.8.1.0.0/iratermdeposit/accountProfitMaster [PATCH]
Deposit Account Services This service is used to create Deposit Accounts Existing
  1. Description and spelling changes.
  2. Header changes - included fields idempotencyKey, idempotencyRetry, idempotencyRequestSource
  3. Models removed - DepositExternalFundingModel
  4. AddlPayinDtilsModel
    • Fields added - id,parentId,referenceNo,mulitmodeXrate,seqno,chqInstrumentNo,draweeAcNo,routingNo,externalFunding,networkCode,instrumentCode,instrumentAmt,instrumentCcy,nachaTxnCode,benfName,narrative,instructionDate,chqInstrumentDate(read-only)
  5. RolloverDetailsModel
    • Fields added - thresholdPayoutAcc
  6. UDEValuesModel
    • Fields made non-mandatory - udeValue
  7. InterestDetailsMcyModel
    • Fields made mandatory - intStartDate
  8. Endpoints removed/deprecated-
    • /service/v14.8.1.0.0/termDepositPayin [PATCH]
    • /service/v14.8.1.0.0/accountProfitMaster [PATCH]
External Parameter Configuration Banks configure and manage external parameters to determine how deposit transactions are processed. Service endpoints are available to create, modify, close, and reopen parameter sets. The integration mode (R-REST API or H-Handoff) controls how each parameter set is processed and how information is exchanged with external systems. The screen displays key parameters, including bank code, along with detailed configuration for each transaction type—such as payment mode, settlement mode, system code, settlement general ledger, integration mode, and directory key. This setup helps ensure that transaction processing is accurate and efficient, supporting the bank's operational and compliance needs. Existing
  1. Description and spelling corrections.
  2. APIs removed - GET /service/v14.8.1.0.0/tdexternalparam/{resourceId}
  3. PUT /service/v14.8.1.0.0/tdexternalparam/{keyId} - Repsonse code changed from 201 to 200
  4. TdExternalParamModel
    • Fields added - rdTransactionCode, principalUnclaimedGl, interestUnclaimedGl, redemptionInterestPayoutGl, suspenseGlForFailedTransaction
    • Mandatory fields - bankCode
  5. paymentMappingModel
    • Fields added - settlementMode,systemCode,integrationMode,integrationMode
    • Mandatory fields - settlementMode,paymentType,integrationMode,systemCode,paymentMode
Deposit Integration Services APIs for deposit certificate generation Existing Descripton changes & Spelling corrections.
Amount Block This service is used to place Amount Block on deposit. Existing
  1. Descripton changes & Spelling corrections.
  2. New endpoints added - GET /service/v14.8.1.0.0/tdamtblk/getById:
  3. TdAmtBlkResponseModel
    • fullAmountBlock - Field removed from request and made internal.
  4. ModifyTDAmtBlkModel
    • New field added - effDate
  5. TDAmtBlkModel
    • Field changed to non-mandatory - ccy
Redemption This service is used to perform online Redemption operation. Existing
  1. Description changes & spelling corrections.
  2. Header changes - included fields idempotencyKey, idempotencyRetry, idempotencyRequestSource
  3. icdredmnDetailsModel
    • Fields added - redemValueDate,redemMethod,waiveReason
Top-up This service is used to perform online Top-Up operation. Existing
  1. Description changes & spelling corrections.
  2. Header changes - included fields idempotencyKey, idempotencyRetry, idempotencyRequestSource
  3. DepositRequestDTO
    • Non-mandatory fields - topupValDt
  4. ProcessDepositTopUpRequestDTO
    • Non-mandatory fields - topupValDt
Initial Funding This service is used to perform online Initial Funding operation. Existing
  1. Description changes & spelling corrections.
  2. Header changes - included fields idempotencyKey, idempotencyRetry, idempotencyRequestSource
  3. InitFundResponseDTO
    • Fields added - intRateAfterFunding
  4. InitFundDepositRequestDTO
    • Non-mandatory fields - initFundValDt
Deposit Enquiry Services This service is used to query the details of Deposit Accounts, Business Products and Payin Maintenances Existing
  1. Description changes & spelling corrections.
  2. Header changes - included fields idempotencyKey, idempotencyRetry, idempotencyRequestSource
  3. End points added - POST /service/v14.8.2.0.0/queryResponseService/.search, POST /service/v14.8.2.0.0/TbsAccountingEntry/.search, POST /service/v14.8.2.0.0/TbsAccountingEntry/.search
  4. TDIctmTdDetailModel
    • Fields added - fundingStatus,holdDate,graceDate,targetProdRollover,thresholdPayoutAcc,depositType
  5. balanceDetailModel
    • Fields added - acyUnCollectedAmount
  6. IctmTdaddnlpayinDtlsModel
    • Fields added - chqInstrumentNo,draweeAcNo,routingNo,externalFunding,networkCode,instrumentCode,instrumentAmt,instrumentCcy,nachaTxnCode,benfName,narrative,instructionDate,chqInstrumentDate
Handoff APIs This service is used to query the details of payments handoff. New New End points:

POST /obrdda-pp-ira-txn-services/service/v14.8.2.0.0/paymentAccountDetails/.search, POST /obrdep-txn-pp-online-services/service/v14.8.1.0.0/glQuery/.search, POST /obrdep-txn-pp-online-services/service/v14.8.2.0.0/paymentAccounting/.search, POST /obrdep-txn-pp-online-services/service/v14.8.2.0.0/TbsAccountingEntry/.search

Parent topic: Release Enhancements