1.2.1 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)
Business Product Service - Existing In 'BasicDetailsModel' model,
  • for 'accountType', enum value has changed from [S,Y] to [S,U]
  • 'description' is a required field
  • 'accountCode' and 'startDate' are no longer required fields
In 'MultiCurrencyModel' model,
  • 'id' and 'acctFeaturesId' are marked as read-only fields
In 'PreferencesModel' model,
  • 'atmRequired', 'passbookFacReq', 'chequeBookReq',
  • 'directBankingReq' are no longer required fields
In 'ChannelDetailsModel' model,
  • 'channelName' is now a read-only field
In 'ChargesModel' model,
  • 'chargeRequired' field is now restricted to a maximum length of 1 and enum as [Y,N]
In 'ChargeProductMappingModel' model,
  • 'id', 'open' and 'chargeId' are now read-only fields
  • 'AccClassRestrictionsModel',
  • 'AccClassBranchRestrictionsModel',
  • 'AccClassBranchRestrictionDetailsModel',
  • 'AccClassCcyRestrictionsModel',
  • 'AccClassCcyRestrictionDetailsModel',
  • 'AccClassTxnCodeRestrictionsModel',
  • 'AccClassTxnCodeRestrictionDetailsModel',
  • 'AccClassCustomerCategoryRestrictionsModel',
  • 'AccClassCustomerCategoryRestrictionDetailsModel' and
  • 'AccClassEntitlementRestrictionsModel'; these models are newly added
Garnishment Parameters - Existing In 'AccountDetailsModel' and 'AccountDetailsResponseModel' models:
  • 'remarks' field is newly added
Joint Holder Maintenance - Existing API Versioning Changes: All Endpoints.
Relationship Maintenance - Existing API Versioning Changes: All Endpoints.
External Relationship Code Maintenance - Existing -
Interest and Charges Maintenance - Existing -
IRA Product Service - Existing In 'BasicDetailsModel' model,
  • 'startDate' is no longer a required field
  • 'description' is now a required field

In 'IraPreferencesModel' model,

  • directBankingReq' is no longer a required field
In 'ChannelDetailsModel' model,
  • 'channelName' is now a read-only field
In 'ChargesModel' model,
  • 'chargeRequired' field is now restricted to a maximum length of 1 and enum as [Y,N]
In 'ChargeProductMappingModel' model,
  • 'id' and 'chargeId' fields are removed
  • 'open' is now a read-only field
IRA Plans Service - Existing Base level:
  • Description and tag name updated

Endpoint '/service/v14.8.2.0.0/iraplans/iracodes' (GET) is newly added

In 'ValidIraPlansModel' model,
  • For 'contributionLimitType', 'description', and 'planType', descriptions are updated
  • 'employerContribApplicable' and 'rmdApplicable' fields are newly added

'IraCodesModelCollection', 'IraCodesModel' and 'GenericDto' models are newly added
ESA Product Service - New -
ESA Plans Service - New -
Status Code Service - New -
Source Code Service - New -
Customer GL maintenance - New -
Account Service API - Existing Base level:
  • Tags updated for all endpoints
  • (AccountServicesAggregateService -> Account Services)
In endpoint '/service/v14.8.1.0.0/accountservices' (PUT),
  • General headers added: 'userId', 'entityId', 'branchCode', 'appId', 'Authorization', 'env'
Endpoint
  • '/service/v14.8.2.0.0/commonAccountservices/aggregate/.search' (POST) is newly added
In 'AccountServicesWebModel' model,
  • 'accountCharges' and 'accountMemoNotes' datasegments are newly added

'AccountMemoNotesModel',

'AccountMemoNotesDetailModel', 'AccountChargesModel',

'AccountChargesDetailsModel',

'AccountChargesProductsModel' and

'AccountChargesDetailsSlabModel'; model definitions are newly added

In 'AccountClosureDetailsModel' model,
  • 'accountClosureDate' is marked as a read-only field
  • 'sourceSystem' field is newly added
In 'ClosureSettlementDetailsModel' model,
  • 'settlementAmount' and 'settlementRefNo' fields are newly added
Account Closure Service API - Existing API Versioning Changes: All Endpoints.
IRA Account Service API   Existing In 'AccountServicesWebModel' model,
  • 'accountCharges' datasegment is newly added
In 'IraAccountDetailsModel' model,
  • 'employerInitiated' field is removed
  • 'inheritedIra' field is newly added
  • 'iraInheritedAccountDetail' datasegment is newly added
In 'AccountClosureDetailsModel' model,
  • 'accountClosureDate' is marked as a read-only field
  • 'sourceSystem' field is newly added
In 'ClosureSettlementDetailsModel' model,
  • 'settlementAmount' and 'settlementRefNo' fields are newly added

'InheritedIraAccountDetailsModel', 'AccountChargesModel',

'AccountChargesDetailsModel',

'AccountChargesProductsModel' and

'AccountChargesDetailsSlabModel' model definitions are newly added
IRA Customer Plan Configuration API   Existing Endpoint
  • '/service/v14.8.2.0.0/iracustomerplan/planTypes/.search' (POST) is newly added
In 'IraCustomerPlanModificationModel' model,
  • an example is added for 'keyId'
In 'IraCustomerPlanModel' model,
  • Descriptions are added for 'customerNo', 'planType',
  • 'planCcy', 'planRefNo', and 'firstContributionDate' fields
  • 'distributionOrder' field is newly added

'IraRmdPaymentDetailsModel', 'CustomerPlanTypeCollection',

'CustomerPlanTypeModel' and 'CustomerPlanQueryModel'

models are newly introduced

In 'IraEmployerDetailsModel' model,
  • for 'effectiveFromDate' field, description is added and pattern is provided
  • for 'employeeType' field, description is added and enum is provided
  • for 'employerName' field, description is added and maximum length is provided
  • for 'annualCompensation' field, description is added
In 'IraCustomerPlanAccountModel' model,
  • Descriptions are added for 'accNo', 'domain', 'isClosed' and 'accBrn' fields
  • Fields 'inheritedIra', 'includeForRmd' and 'priorityOrder' are newly added
ESA Customer Plan Configuration API - New -
ESA Account Service API - New -
Check/Cheque Book and related Services - Existing -
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
Garnishment order - Existing In 'AccountDetailsModel' and 'AccountDetailsResponseModel' models:
  • 'remarks' field is newly added
Courtesy pay - Existing API Versioning Changes: All Endpoints.
Non Financial Activity - Existing  
IRA Transaction Service - Existing Endpoints
  • '/service/v14.8.1.0.0/contribution' (POST)
  • '/service/v14.8.1.0.0/distribution' (POST)
    • Headers 'idempotencyRequestSource', 'idempotencyRetry' and 'idempotencyKey' are newly added

Endpoint '/service/v14.8.2.0.0/accEnquiry/.search' (POST) is newly added

Endpoint '/service/v14.8.2.0.0/checkPenalty' (POST) is newly added

Endpoint '/service/v14.8.1.0.0/checkPenalty' (POST) is marked as deprecated

In 'IraTxnReqModel' model,
  • 'branch' field is marked as read-only and hence is no longer a required field
  • 'employerContribution' field is not a read-only field and a default value is provided
  • 'paymentMethod' field -> new values are added for ENUM
  • 'iraCode2', 'previousYearRmd' and 'trusteeToTrusteeTransfer' fields are newly added
In 'IraTxnValidAccountsModel' model,
  • Fields 'inheritedIra' and 'isClosed' are newly added
In 'IraBalanceModel' model,
  • Field 'rmdWaive' is newly added
In 'TaxPerFyModel' model,
  • Datasegment 'rmdInfo' is newly added
In 'IraPenaltyReqModel' model,
  • Field 'currency' is now required

'RmdInformation', 'IraTransferReqModel',

'IraTransferResponse', 'IraRolloverReqModel',

'IraRolloverResponse', 'PenaltyReqModelV148200',

'AccountsPenaltyReqModel', 'PenaltyModelV148200',

'AccountPenaltyModel', 'AccEnquiryRequestModel',

'AccLevelDataModel', 'IraAccEnquiryResponseModel',

'PaymentAccountDetailsRequest' and

'PaymentAccountDetailsModel' models are newly added
ESA Transaction Service   New -
Integration Service   Existing API Versioning Changes: All Endpoints.
New Fields added:
  1. 'accCcy' in AccountBalanceRequestModel.
  2. 'accountType' in AccountBalanceResponse.
Statement Generation   Existing -

Parent topic: Release Enhancements