Holdings

Holdings API allows the user to fetch the account level posted transactions from the Holdings Micro Service. These APIs also allow the user to fetch the balance details for a particular account.

The user must install and integrate the microservice app with the base application before consuming the Holdings API. For more information, click here.

Name Description Introduced In
GetAccountTransactionsByType This API is invoked from the client to fetch the pending Transactions from T24 (customizable) and Posted Transactions from the Holdings Micro Services. (This API is used in OLB application) 2020.04
GetAccountPostedTransactions This API is invoked from the client to fetch the posted Transactions from the Holdings Micro Services. (This is used in Mobile application) 2020.04

NOTE: In this scenario, the GetAccountTransactionsByType API is used to fetch the pending transactions from T24 and posted transactions from Microservice for the OLB application, whereas the GetAccountPostedTransactions API is used to fetch the posted transactions for the Mobile application. The output response of the GetAccountTransactionsByType and GetAccountPostedTransactions APIs is the same as both the APIs are pointing to the same endpoint (Microservice). Therefore, when you invoke the GetAccountPostedTransactions API, the output response of this API contains same details.

Closed GetAccountTransactionsByType
 
Description: This API is invoked from the client to fetch the Pending Transactions from T24 (customizable) and Posted Transactions from the Holdings Micro Services. (This API is used in OLB application)
Method: POST
URL: /services/data/v1/RBObjects/operations/Transactions/getAccountTransactionByType
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

accountID (Mandatory)

Specifies the account number for which the transactions must be fetched

transactionType

The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals.

offset

Specifies the starting index of the sorted records that are used in pagination.

limit

Specifies the ending index of the sorted records that are used in pagination.

order

Specifies the sorting order for the response (Ascending/Descending).

sortBy

Specifies the sorting criteria for the response such as amount or transactionDate.

{
"accountID" : "GB0010001-87122",
"transactionType" : "LoanSchedule",
"offset": 0,
"limit" : 10,
"order" : "desc",
"sortBy": "amount"
}}
Response:
ClosedView the Response Parameters

Transactions [ ]

The collection that is returned to the client.

Parameters

Transactions/installmentAmount

Specifies the installment amount that must be paid by the user.

Transactions/principal

Specifies the principal amount for the loan taken.

Transactions/interest

Specifies the interest amount that has to be paid for the loan takn.

Transactions/outstandingBalance

Specifies the outstanding amount that the user has availed.

Transactions/charges

Specifies the charges levied on the user.

Transactions/tax

Specifies the tax amount levied on the user for availing the loan.

Transactions/insurance

Specifies the insurance amount on the loan.

Transactions/cumulativeInterest

Specifies the cumulative interest that has been accumulated.

Transactions/statusDescription

Specifies the status of the loan transaction.

Transactions/installmentType

Specifies the type of installment.

Transactions/paymentDate

Specifies the date for payment of the interest.

ClosedView the Sample Response Code for Mock Services 
{
  "Transactions": [
    {
      "installmentAmount": "9850",
      "principal": "5960",
      "interest": "3450",
      "outstandingBalance": "144300",
      "charges": "250",
      "tax": "440",
      "insurance": "440",
      "cumulativeInterest": "94300",
      "installmentType": "DUE",
      "paymentDate": "2020-08-28"
    },
   {
      "installmentAmount": "9850",
      "principal": "5960",
      "interest": "3450",
      "outstandingBalance": "144300",
      "charges": "250",
      "tax": "440",
      "insurance": "440",
      "cumulativeInterest": "94300",
      "installmentType": "PAID",
      "paymentDate": "2019-08-28"
    }
   ], 
   "opstatus": 0,
  "httpStatusCode": 0
}
ClosedView the Sample Response Code for Transact Services 
{
   "Transactions":[
      {
         "installmentAmount":"500",
         "principal":"75000",
         "outstandingBalance":"-75000",
         "charges":"500",
         "installmentType":"DUE",
         "paymentDate":"2020-03-19"
      },
      {
         "installmentAmount":"1107.43",
         "principal":"953.32",
         "interest":"157.86",
         "outstandingBalance":"-74046.68",
         "installmentType":"DUE",
         "paymentDate":"2020-04-03"
      }
   ],
   "opstatus":0,
   "httpStatusCode":200
}
ClosedView the Sample Response Code for Microservices 
{"Transactions":[
      {
         "amount":"0",
         "fromAccountBalance":"0",
         "installmentAmount":"610.0",
         "principal":"300000.0",
         "interest":"0.0",
         "outstandingBalance":"-300000.0",
         "charges":"610",
         "tax":"0.0",
         "installmentType":"PAID",
         "paymentDate":"2020-04-17"
      },
      {
         "amount":"0",
         "fromAccountBalance":"0",
         "installmentAmount":"897.6",
         "principal":"761.98",
         "interest":"123.29",
         "outstandingBalance":"-299102.4",
         "charges":"0",
         "tax":"12.33",
         "installmentType":"PAID",
         "paymentDate":"2020-04-20"
      },
      {
         "amount":"0",
         "fromAccountBalance":"0",
         "installmentAmount":"897.54",
         "principal":"762.61",
         "interest":"122.66",
         "outstandingBalance":"-297307.3",
         "charges":"0",
         "tax":"12.27",
         "installmentType":"PAID",
         "paymentDate":"2020-04-26"
      },
      {
         "amount":"0",
         "fromAccountBalance":"0",
         "installmentAmount":"897.51",
         "principal":"762.92",
         "interest":"122.35",
         "outstandingBalance":"-296409.8",
         "charges":"0",
         "tax":"12.24",
         "installmentType":"DUE",
         "paymentDate":"2020-04-29"
      }
   ],
   "opstatus":0,
   "httpStatusCode":0
}
Error Code(s): Error Code: 20041
Error Message: "Message stating backend failed while retrieving transactions"
Associated Services:
Integration Services Orchestration Services
  • dbpNonProductServices: getAccountDetails (Mock services)
  • HoldingsMicroServicesJava: getAccountPendingAndPostedTransactions (Microservice)
  • CommonOrchestrationService: getTransactions (Transact)
Closed GetAccountPostedTransactions
 
Description: This API is invoked from client to fetch the Posted Transactions from the Holdings Micro Services. (This is used in Mobile application)
Method: POST
URL: /services/data/v1/RBObjects/operations/Transactions/getAccountTransactionByType
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

accountID (Mandatory)

Specifies the account number for which the transactions must be fetched

transactionType

The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals.

offset

Specifies the starting index of the sorted records that are used in pagination.

limit

Specifies the ending index of the sorted records that are used in pagination.

order

Specifies the sorting order for the response (Ascending/Descending).

sortBy

Specifies the sorting criteria for the response such as amount or transactionDate.

{
"accountID" : "GB0010001-87122",
"transactionType" : "All",
"offset": 0,
"limit" : 10,
"order" : "desc",
"sortBy": "amount"
}}
Response:
ClosedView the Response Parameters

Transactions [ ]

The collection that is returned to the client.

Parameters

Transactions/payeeCurrency

Specifies the currency of the amount that has been transacted.

Transactions/transactionId

Specifies the unique transaction identifier that gets created at the time of transaction.

Transactions/fromAccountNumber

Specifies the account number from where amount is debited.

Transactions/description

Specifies the reference generated at the time of transaction creation.

Transactions/transactionType

Specifies the type of transaction.

Transactions/amount

Specifies the transacted amount.

Transactions/transactionDate

Specifies the date of transaction.

Transactions/postedDate

Specifies the date on which the transaction was posted to the actual backend.

Transactions/statusDescription

Specifies the status of the transaction (Posted/Pending).

Transactions/fromAccountBalance

Specifies the balance snapshot of the debit account at the time of transaction.

Transactions/transactionsNotes

Specifies the user notes entered at the time of transaction creation.

ClosedView the Response Sample Code 
{
  "Transactions": [
    {
      "payeeCurrency": "INR",
      "transactionId": "20204",
      "fromAccountNumber": "87122",
      "description": "Transfer To My Loan Account",
      "transactionType": "InternalTransfer",
      "amount": "-75.91",
      "transactionDate": "2020-02-11T05:33:42Z",
      "postedDate": "2020-02-11T05:33:42Z",
      "statusDescription": "Pending",
      "fromAccountBalance": "5328.66",
      "transactionsNotes": "",
    },
    {
      "payeeCurrency": "INR",
      "amountRecieved": "0",
      "fromAccountNumber": "87122",
      "description": "Transfer To Albert",
      "transactionType": "ExternalTransfer",
      "amount": "-37.19",
      "transactionDate": "2020-02-11T05:33:42Z",
      "postedDate": "2020-02-11T05:33:42Z",
      "statusDescription": "Pending",
      "fromAccountBalance": "5252.75",
      "transactionsNotes": "",
    }
  ]
}
Error Code(s): Error Code: 20041
Error Message: "Message stating backend failed while retrieving transactions"
Associated Enterprise APIs: getAccountPostedTransactions (HoldingsMicroServicesJava)

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?