Transaction summary API

  • Updated

Transaction summary API

Description

This API fetches the transaction summary of the borrower or any particular loan Account. 

It considers below transactions for transaction Summary

  1. Loan Payment Transactions

  2. Other Loan Transactions

  3. Disbursal Transactions

  4. Charges on Loan Account

Definition

GET https://<domain>/services/apexrest/peer/v2/loanAccounts/getStatement/*

Parameters

The table given below provides details of the request parameters used by this web service:  

Field Type Description

LoanAccountid*

String

  • This is used to identify the Loan Account. This should be passed in the URL as specified under the sample request.

  • The value that you pass is compared against a pre-defined attribute of the Lending Account (peer__Loan_Account__c) object which acts as the primary key.

  • You can define the attribute using the  Loan Account ID Field of the  API Configuration custom setting.

borrowerId*

String

  • This is the identity of the borrower.

  • The value that you pass is compared against a pre-defined attribute of the Account object which acts as the primary key

  • You can define the attribute using the  Account ID Field of the  API Configuration custom setting

additionalPaymentFields

 String

This is used to denote additional payment fields to be queried.

additionalDuesDetailsFields

String

 This is used to denote additional bill fields to be queried.
status String

This is used to filter the loan accounts based on the status

It is a comma separated list having different status for example Partial Application, Approved, Active-Good Standing etc.
additionalLoanFields String This is used to denote additional Loan Fields to be queried.
additionalChargeFields String This is used to denote additional Charge Fields to be queried.
additionalOtherTxnFields String This is used to denote additional Charge Fields to be queried.
additionalDisbursalFields String This is used to denote additional Disbursal Fields to be queried.
additionalPmtReversalFields String This is used to denote additional Payment Reversal Fields to be queried.

Error messages

When you use this web service you can receive the possible error messages as shown in the table below:

Error Code Error Message System.Label Reason HTTP Status Code

INVALID_INPUT

Loan Account Id is null.

LOAN_ACCOUNT_ID_NULL

Loan Account ID for Loan is not specified in the request parameters.

400

API_EXCEPTION

<exception_message>

Not Applicable

If any validation fails or any unexpected error occurs during the processing of the request, system will raise the exception.

500

Sample request

The sample request to be sent is as shown below:

https://<domain>/services/apexrest/v2/loanAccounts/getStatement?borrowerId=001j000000ZUVqy

Example:

https://<domain>/services/apexrest/peer/v2/loanAccounts/getStatement?borrowerId=001j000000ZUVqy&status=Active - Bad Standing&additionalPaymentFields=loan__Balance__c&additionalDuesDetailsFields=loan__Compounding_Interest_Billed__c&additionalPmtReversalFields=loan__Custom_Logic__cParameters

Sample response

"status": "SUCCESS",

  "rowNumber": -1,

  "response": [

    {

      "transactionsList": [

        {

          "txnObj": {

            "attributes": {

              "type": "loan__Loan_Disbursal_Transaction__c",

              "url": "/services/data/v32.0/sobjects/loan__Loan_Disbursal_Transaction__c/a2vj0000000MohdAAC"

            },

            "loan__Loan_Account__c": "a2sj0000001SHgWAAW",

            "Id": "a2vj0000000MohdAAC",

            "Name": "LDTI-0000000005",

            "loan__Cleared__c": true,

            "loan__Disbursal_Date__c": "2015-03-10",

            "loan__Disbursed_Amt__c": 2400,

            "loan__Mode_of_Payment__c": "a3Yj00000008fPNEAY"

          },

          "transactionType": "Loan Disbursal Transaction",

          "transactionDate": "2015-03-10"

        },

        {

          "txnObj": {

            "attributes": {

              "type": "loan__Other_Transaction__c",

              "url": "/services/data/v32.0/sobjects/loan__Other_Transaction__c/a3Rj00000006IuEEAU"

            },

            "loan__Loan_Account__c": "a2sj0000001SHgWAAW",

            "Id": "a3Rj00000006IuEEAU",

            "Name": "OLTID-0000000004",

            "loan__Billing_Method__c": "Declining Balance",

            "loan__Frequency_of_Loan_Payment__c": "Monthly",

            "loan__Interest_Only_Period__c": 0,

            "loan__Interest_Rate__c": 12,

            "loan__Number_of_Installments__c": 4,

            "loan__Principal_Remaining__c": 2400,

            "loan__Same_monthly_payment__c": false,

            "loan__Total_Fees_Due__c": 0,

            "loan__Total_Interest_Due__c": 4.8,

            "loan__Transaction_Type__c": "Reschedule",

            "loan__Txn_Date__c": "2015-03-16",

            "loan__Txn_Amt__c": 0,

            "loan__Passed_Term__c": 0,

            "loan__Additional_Interest_Amt__c": 0,

            "loan__Repayment_Start_Date__c": "2015-03-17"

          },

          "transactionType": "Other Loan Transaction",

          "transactionDate": "2015-03-16"

        },

In This Article