1. Release Notes
  2. Release Notes
  3. Release Enhancements
  4. API Enhancements for Retail Accounts Service

1.2.2 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)
Account Service API Service to manage life cycle business actions of an acocunt Existing
  • Request body for the account closure endpoint '/service/v1/accountservices/{keyId}/close' is changed to 'AccountClosureDetailsWebModel'.
  • Two new properties added to'AccountServicesWebModel': 'accountProfileMaster' and 'accountClosureDetails'.
  • Definitions added for the following models :
    • AccountProfileMasterModel
    • AccountProfileModel
    • AccountClosureDetailsModel
    • AccountClosureDetailsWebModel
    • ClosureSettlementDetailsModel
Business Product Service API for Business Product creation and amend Existing
  • Two new properties added to 'PreferencesModel'
    • 'autoClosureReq': String type flag
    • 'closureDetails': List of 'ClosureDetailsModel'
  • Model 'ClosureDetailsModel' is newly added.
Integration Service Serice to support inquries Existing
  • New paths for 'accountBalanceDetailSummary' and 'relatedAccounts' are added under the existing '/v1' path:
    • '/ob/oba/retailacc/v1/accountBalanceDetailSummary/.search' with HTTP method as 'POST'
    • '/ob/oba/retailacc/v1/relatedAccounts/.search' with HTTP method as 'POST'
  • New Definitions added for the models:
    • ‘AccountBalanceRequestModel’
    • ‘AccountBalanceResponse’
    • ‘RelatedAccountsResponseModel’
    • ‘RelatedAccountsResponse’
    • ‘RelatedAccountsModel’.
Transaction Balance Service Trasaction posting and accounting Existing
  • Maximum permissible length for 'courtesyPaySource' tag under the Models 'AccountingRequestDetails' and 'AccountingResponseDetails' is changed from 15 to 20.
  • Property ‘courtesyPaySource’ added to ‘ AmountBlockRequest’ and ‘AmountBlockResponseDetails’ definition.
  • New Model definitions are added:
    • AccountBalanceRequest
    • AccountingDetailsQueryRequest
    • EAQueryRequest
    • AmountBlockDetailsQueryRequest
    • ECAQueryRequest
    • AccountRegdDetailsQueryRequest
    • UncollectedCreditsAccountsQueryRequest
    • UncollectedCreditsAvailableDatesQueryRequest
    • AccountingTransactionSweepQueryRequest
  • Path has been changed from '/obcdda-pp-transaction-balance-service/balances’ to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/balances/.search’ and the Method has been changed to ‘POST’, in body parameter the items type has changed from 'string' to ‘AccountBalanceRequest'.
  • Path has been changed from '/obcdda-pp-transaction-balance-service/balances/account/{accountNo}’to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/balances/account/.search’and the method has changed from ‘GET’ to ‘POST’.Input path is replaced by ‘body’ with the schema of ‘AccountBalanceRequest’.
  • Path '/obcdda-pp-transaction-balance-service/postprocessing/uncollectedcredits/collectall’has changed to ' /obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/accountings/uncollectedCredits/collection/accounts’.
  • Path ' /obcdda-pp-transaction-balance-service/query/accountingdetails/account/{accNo}’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/accountings/details/queries/.search’and Method changed from ‘GET’ to ‘POST’.Input parameters replaced with ‘AccountingDetailsQueryRequest’.
  • Path '/obcdda-pp-transaction-balance-service/query/accountingtransactions’ is changed to ' /obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/accountings/queries’ and method changes from ‘GET ‘ to ‘PUT’.Input parameters replaced with 'EAQueryRequest’.
  • Path '/obcdda-pp-transaction-balance-service/query/amountblockdetails/account/{accNo}’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/amountBlocks/details/queries/.search’and method changed from ‘GET’ to ‘POST’.Input parameters replaced with ‘AmountBlockDetailsQueryRequest'.
  • Path ' /obcdda-pp-transaction-balance-service/query/amountblocktransactions’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/amountBlocks/queries’ and method changed from ‘GET’ to ‘PUT’ , and input parameters replaced with ‘ECAQueryRequest’model.
  • Path '/obcdda-pp-transaction-balance-service/query/regddetails/account/{accNo}’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/accounts/regdDetails/queries/.search'and method changed from ‘GET’to ‘POST’,and input parameters replaced with ‘AccountRegdDetailsQueryRequest’.
  • Path '/obcdda-pp-transaction-balance-service/query/sweepdetails/account/{accNo’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/accounts/sweepDetails/queries/.search’ and method changed from ‘GET’ to ‘POST’, and input parameters are replaced with ’AccountingTransactionSweepQueryRequest’ model.
  • Path '/obcdda-pp-transaction-balance-service/query/uncollectedcredits/listaccounts’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/uncollectedCreditsAccounts/queries/.search’ and mthod changed from ‘GET’ to ‘POST’, and input parameters replaced with 'UncollectedCreditsAccountsQueryRequest’ model.
  • Path '/obcdda-pp-transaction-balance-service/query/uncollectedcredits/listavailabledates/account/{accNo}’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/uncollectedCreditsAvailableDates/accounts/queries/.search’ and method changed from ‘GET’ to ‘post’, and input parameters replaced with ‘UncollectedCreditsAvailableDatesQueryRequest’ model.
  • Path '/obcdda-pp-transaction-balance-service/transaction/accounting’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/accountings’.
  • Path '/obcdda-pp-transaction-balance-service/transaction/amountblock’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/amountBlocks’.
  • Path '/obcdda-pp-transaction-balance-service/transaction/amountblock/legal’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/legalBlocks’.
  • Path '/obcdda-pp-transaction-balance-service/transaction/amountblock/release’ changed to '/obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/amountBlocks/release’.

Parent topic: Release Enhancements