1.2.2 API Enhancements for Retail Accounts Service

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

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

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 - Existing
Endpoint Level Changes:
  1. API VERSIONING CHANGES: All existing endpoints
  2. New Endpoints:
    • /service/v14.8.1.0.0/accountservices/iraPrerequisite/.search (POST)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountBasicDetails (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountStatus (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountFeatures (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountOperatingInstructions (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraInterestDetails (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountStatementPreferences (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountPreferences (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountMis (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraProvisioningAndGl (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountSignatory (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountNominee (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountGuardian (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountAddress (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraAccountProfileMaster (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/iraEffectiveAddress (PATCH)
    • /service/v14.8.1.0.0/iraAccountservices/accountCreationValidation (POST)
    • /service/v14.8.1.0.0/iraAccountservices/accountModificationValidation (PUT)
Field Level Changes accountNominee Data segment;-
  1. For 'nomineeCountry' and 'guardianCountry' fields maximum length restriction is removed and it is indicated to pass the country code maintained in common core .
  2. 'nomineeType' and 'nomineeSharePercentage' new fields are added.
  3. 'iraAccountDetails' data segment in the existing Web Model .
  4. 'dormancyParameter' within accountStatus datasegmet now accepts value from the enum [A,M].
  5. 'primaryDueType', 'primaryDueOnDate', 'primaryDueYear' fields added in accountStatementPreferencesModel 'primaryOnAccOpenDate' is removed from the same.
IRA Customer Plan Configuration API - New -
IRA Transaction Service - Existing
Endpoint Level Changes:
  1. API VERSIONING CHANGES: All Endpoints
  2. 'simulation' field added as query param for contribution and distribution endpoints.
Field Level Changes
  1. 'employerContribution' field added in IraTxnReqModel
  2. brn' is marked as mandatory in IraTxnReqDetails
  3. required field 'currency' added in IraTxnQueryModel
  4. 'currentYear' field added in TaxPerFyModel
Transaction Balance Service - Existing
Endpoint Level Changes: API VERSIONING CHANGES
  1. /ob/oba/tbs/v1/transactions/accountings -> /service/v14.8.1.0.0/transactions/accountings
  2. /ob/oba/tbs/v1/transactions/amountBlocks -> /service/v14.8.1.0.0/transactions/amountBlocks
  3. /ob/oba/tbs/v1/transactions/legalBlocks -> /service/v14.8.1.0.0/transactions/legalBlocks
Account Service API - Existing
Endpoint Level Changes:
  1. Removed

    /ob/oba/retailacc/v1/accounts/accountClosureDetails (PATCH)

  2. API Versioning Changes: All Endpoints
Field Level Changes
  1. accountNominee Data segment;-
    • For 'nomineeCountry' and 'guardianCountry' fields maximum length restriction is removed and it is indicated to pass the country code maintained in common core.
    • 'nomineeType' and 'nomineeSharePercentage' new fields are added.
  2. 'dormancyParameter' within accountStatus datasegmet now accepts value from the enum [A,M].
  3. 'primaryDueType', 'primaryDueOnDate', 'primaryDueYear' fields added in accountStatementPreferencesModel 'primaryOnAccOpenDate' is removed from the same.
Account Closure Service API - Existing API Versioning Changes: All Endpoints.
Business Product Service - Existing
Endpoint Level Changes:
  1. API Versioning Changes: All Endpoints
Field Level Changes
  1. 'regionalParam' data segment added in existing web model.
  2. 'validateInitFund', 'fundingOption','dfltMaxOpenBalance','maxOpenBalance' fields added in MinBalanceModel Data segment.
  3. 'primaryDueType', 'primaryDueOnDate' fields added in accountStatementPreferencesModel 'primaryOnAccOpenDate' is removed from the same.
IRA Product Service - Existing API Versioning Changes: All Endpoints.
Field Level Changes
  1. 'regionalParam', 'charges', 'regulatoryparams', 'minBalance' data segments are added in existing web model.
  2. 'primaryDueType', 'primaryDueOnDate' fields added in accountStatementPreferencesModel 'primaryOnAccOpenDate' is removed from the same.
Integration Service - Existing API Versioning Changes: All Endpoints.
New Fields added:
  1. 'accCcy' in AccountBalanceRequestModel.
  2. 'accountType' in AccountBalanceResponse.
Interest and Charges Maintenance - Existing /icProduct (POST) Removed
New Endpoints Introduced:
  • /service/v14.8.1.0.0/icInput/icProducts (GET)
  • /service/v14.8.1.0.0/icInput/icProductsDetails (GET)
  • /service/v14.8.1.0.0/icInput/icdrnavs (POST)
  • /service/v14.8.1.0.0/icInput/icdrnavs (PUT)
  • /service/v14.8.1.0.0/icInput/icdrnavs (GET)
  • /service/v14.8.1.0.0/icInput/icdrnavs/rateCodeDetail (GET)
  • /service/v14.8.1.0.0/icInput/icRates (POST)
  • /service/v14.8.1.0.0/icInput/icRates (PUT)
  • /service/v14.8.1.0.0/icInput/icRates (GET)
  • /service/v14.8.1.0.0/icInput/udeVals/genCondn (GET)
  • /service/v14.8.1.0.0/icInput/udeVals/genCondn (POST)
  • /service/v14.8.1.0.0/icInput/udeVals/genCondn (PUT)
  • /service/v14.8.1.0.0/icInput/prodUdeList (GET)
  • /service/v14.8.1.0.0/icInput/icttEntries/histories/.search (POST)
  • /service/v14.8.1.0.0/icInput/rate/icRates/.search (POST)
Courtesy pay - Existing API Versioning Changes: All Endpoints.
Garnishment Order - Existing API Versioning Changes: All Endpoints.
IRA Plans Service - New -
Garnishment Parameters - Existing API Versioning Changes: All Endpoints.
Joint Holder Maintenance - Existing API Versioning Changes: All Endpoints.
Relationship Maintenance - Existing API Versioning Changes: All Endpoints.

Parent topic: Release Enhancements