API Enhancements for Retail Accounts Service

This topic provides details of incremental changes in ReSTful API for Retail Accounts.

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

API Name (as in Swagger) API Functional Description New API/ Existing Brief of the Change(s)
IRA Account Service API IRA Account Opening New -
IRA Transaction Service Posting of transactions reckoning for Contributions and Distributions New -
Statement Preferences To facilitate statement generation based on account open date. Existing Field "onAccOpenDate" of type String is newly added in AccountStatementPreferencesDTO.
Transaction Balance Service Conversion of ‘’GET” end points to POST to ensure PII compliance Multiple Refer to the Swagger for details Existing
  • Existing "sweepApplicable" field is restricted to contain the values ['Y','N'] and this field is added in the following models:
    • AmountBlockRequestDetails
    • AmountBlockResponseDetails
  • "ChannelTransactionRequest" model is newly introduced Following endpoints were newly introduced:
    • /ob/oba/tbs/v1/transactions/channel/accountingPayloadInvocation (POST)
    • /ob/oba/tbs/v1/transactions/channel/amountBlockPayloadInvocation (POST)
    • /ob/oba/tbs/v1/transactions/channel/modifyBlockPayloadInvocation (POST)
    • /ob/oba/tbs/v1/transactions/channel/releaseBlockPayloadInvocation (POST)
    • /ob/oba/tbs/v1/transactions/channel/balanceEnquiry (POST)
    • /ob/oba/tbs/v1/transactions/channel/miniStatement (POST)
    • /ob/oba/tbs/v1/transactions/channel/chequebook (POST)
    • /ob/oba/tbs/v1/transactions/channel/adhocstatement (POST)
Account Service API
  • Introduced a new method PATCH to update existing field level data
  • Modifications done to ensure API Standards
 Existing
  • The following endpoints were newly introduced:
    • /ob/oba/retailacc/v1/accountservices/.search (POST)
    • /ob/oba/retailacc/v1/accountservices (PUT)
    • /ob/oba/retailacc/v1/accountservices/close (PATCH)
    • /ob/oba/retailacc/v1/accountservices/reopen (PATCH)
    • /ob/oba/retailacc/v1/accountservices/aggregate/.search (POST)
    • /ob/oba/retailacc/v1/accountservices/customerinfo/.search (POST)
    • /ob/oba/retailacc/v1/accountservices/getChequeBookByAccountNumber/.search (POST)
    • /ob/oba/retailacc/v1/accountservices/customerAccounts/.search (POST)
    • /ob/oba/retailacc/v1/accountCreationValidation (POST)
    • /ob/oba/retailacc/v1/accountModificationValidation (PUT)
    • /ob/oba/retailacc/v1/accounts/accountBasicDetails (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountStatus (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountFeatures (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountOperatingInstructions (PATCH)
    • /ob/oba/retailacc/v1/accounts/interestDetails (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountStatementPreferences (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountPreferences (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountMis (PATCH)
    • /ob/oba/retailacc/v1/accounts/provisioningAndGl (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountSignatory (PATCH)
    • /ob/oba/retailacc/v1/accounts/jointHolder (PATCH)
    • /ob/oba/retailacc/v1/accounts/multiCurrencyAccount (PATCH)
    • /ob/oba/retailacc/v1/accounts/chequeBook (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountNominee (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountGuardian (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountAddress (PATCH)
    • /ob/oba/retailacc/v1/accounts/limits (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountSecuredOverdueDetails (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountUnsecuredOverdueDetails (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountCourtesyPayDetails (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountProfileMaster (PATCH)
    • /ob/oba/retailacc/v1/accounts/effectiveAddress (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountMemoNotes (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountSweep (PATCH)
    • /ob/oba/retailacc/v1/accounts/accountClosureDetails (PATCH)
  • Apart from the existing account Creation endpoint, all other endpoints with prefix "/service/v1/accountservices" were removed and the PII Data-compatible versions of them was introduced as mentioned in first point
  • Following models are newly introduced:
    • AccountModificationModel
    • InterestDetailsModel
    • NonFinancialActivityModel
    • CustomerAccountsRequestModel
    • AccountNumberRequestModel
    • AccountServicesAggRequestModel
    • CustomerInfoRequestModel
    • AccountReopenRequestModel
    • AccountServicesCloseRequestModel
    • PatchModel
    • Operation
  • Readonly Audit Fields: ("makerBranch", "makerTimeZone", "makerUTC", "checkerBranch", "checkerTimeZone", "checkerUTC") were added in all the models defining a data segment within "accountServicesWebModel".
  • New fields were added under "AccountSecuredOverdueLinkagesModel":
    • "prodMargin": Integer type field
    • "blockRefNo": String type field
  • New fields were added under "AccountUnsecuredOverdueLinkagesModel":
    • "prodMargin": Integer type field
    • "ccy": String type field
  • Following fields that were mandatory previously, are now Optional Fields under "AccountBasicDetailsModel":
    • accountName
    • accountOpenDate
  • Following fields were added/removed from "ChequeBookModel":
    • printStatus: removed
    • deliveryMode: added as a Mandatory Field( String type field)
    • requestStatus: removed
  • "limitCurrency" field was removed from "AccountLimitModel"
Account Closure Service API - Existing
  • Query Parameter within the endpoint /service/v1/accountclosure/errorRecords (GET) has been defined as an enum that can contain "C" or "E"
  • Newly introduced the endpoint: /ob/oba/accountclosure/v1/closureDetails/.search (POST)
  • Following renaming of the field is done under "AutoClosureErrorModel" 3.1) "eaRefNo" -> "txnRefNo"
  • Following models have been newly introduced:
    • AccountClosureReqModel
    • AccountClosureResponseModel
Business Product Service Additions refer to the enhancements Existing
  • Readonly Audit Fields: ("makerBranch", "makerTimeZone", "makerUTC", "checkerBranch", "checkerTimeZone", "checkerUTC") were added in all the models defining a data segment within "accountClassWebModel"
  • "margin" field of type number has been newly added under OverdueParametersModel and CasaOdInterestModel
  • "primaryOnAccOpenDate" field of type string has been newly added under StatementPreferencesModel
IRA Product Service Modifications in IRA product creation Existing
  • "AccountClassWebModel" was renamed to "IraProductWebModel"
  • "PreferencesModel" was renamed to "IraPreferencesModel"
  • Following fields were removed from within data segments of "IraPreferencesModel":
    • "iraType" from BasicDetailsModel
    • "iraJointAccountAllowed" from IraPreferencesModel
    • "iraCoolingOffPeriod" from IraPreferencesModel
  • "accountCode" is now an Optional field within BasicDetailsModel
  • Enum has been added for bankingChannel within ChannelDetailsModel: ["IB", "IVR", "MOB"]
  • Enum has been added for primaryCycle within ChannelDetailsModel: ["D", "W", "F", "M", "Q", "S", "A"]
  • "primaryOnAccOpenDate" Field of type String has been newly added within ChannelDetailsModel
Integration Service - Existing
  • Following endpoints have been newly added:
    • /ob/oba/retailacc/v1/retailCustomer/lastTxns/.search (POST)
    • /ob/oba/retailacc/v1/retailCustomer/assetsLiab/.search (POST)
    • /ob/oba/retailacc/v1/retailCustomer/alerts/.search (POST)
    • /ob/oba/retailacc/v1/retailCustomer/summary/.search (POST)
    • /ob/oba/retailacc/v1/customerHousehold/.search (POST)
    • /ob/oba/retailacc/v1/householdBalance/.search (POST)
    • /ob/oba/retailacc/v1/retailCustomer/casaSummary/.search (POST)
    • /ob/oba/retailacc/v1/accountBalanceDetailSummary/.search (POST)
    • /ob/oba/retailacc/v1/relatedAccounts/.search (POST)
  • Existing endpoints with prefix "/service/v1/" were removed and the PII Data-compatible versions of them was introduced as mentioned in first point
  • CustomerRequestModel is newly introduced.
Non-Financial Activity 1 and 2 are enhancements for PII compliance Existing
  • Following endpoint have been renamed:
    • /service/v1/nonfinancialactivity (POST) -> /ob/oba/tbs/v1/nonfinancialactivity/.search (POST)
    • Query Parameter: customerNumber has been removed
  • NonfinancialActivityRequestModel is newly defined
Garnishment Order Enhancements for the purpose of PII compliance Existing
  • Following endpoints have been newly introduced:
    • /ob/oba/retailtxn/v1/garnishment-order/.search (POST)
    • /ob/oba/retailtxn/v1/garnishment-order/accounts/.search (POST)
    • /ob/oba/retailtxn/v1/garnishment-order/history/.search (POST)
  • Existing GET endpoints were removed and the PII Data-compatible versions of them was introduced as mentioned in first point
  • Newly introduced models:
    • GarnishmentRequestModel
    • GarnishmentHistoryRequestModel
    • GarnishmentAccountsRequestModel