Loans Payoff

Loans Payoff is a T24 module that is used to simulate and calculate the interest and loan amount that a user must pay before a particular date. By using the Experience APIs associated with the Loans Payoff module, you can create the simulation for a loan amount and fetch the response.

Name Description Introduced In
createSimulationt24 This API is used to create a loan simulation in T24 for a given lending arrangement. 2020.07
getBillDetailst24 This API is used to fetch the simulated bill details from T24. 2020.07
ClosedcreateSimulationt24
 
Description: This API is used to create a loan simulation in T24 for a given lending arrangement.
Method: POST
URL: /services/data/v1/LoanPayoff/objects/LoanSimulateObject
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

activityId (Mandatory)

Specifies the T24 activity ID.

productId (Mandatory)

Specifies the T24 product ID.

arrangementId (Mandatory)

Specifies the T24 arrangement ID.

effectiveDate (Mandatory)

Specifies the date to simulate and calculate the loan payoff amount.

{
    "activityId": "LENDING-CALCULATE-PAYOFF",
    "productId": "MORTGAGE",
    "arrangementId": "AA1910770HQK",
    "effectiveDate" : "20200623"
}
Response:

Parameters

success

Specifies the status of the loan simulation.
Error Code(s):
  • Error Code: 20041
    Error Message: Backend Failed.
  • Error Code: 20001
    Error Message: Invalid Payload.
  • Error Code: 20400
    Error Message: Internal Error.
  • Error Code: 20043
    Error Message: Unable to read value for number of days from fabric configuration.
Associated T24 APIs:
  • T24BasePath/infinity-retail-api/api/v1.0.0/holdings/simulationCapture/{ArrangementID}
ClosedgetBillDetailst24
 
Description: This API is used to fetch the simulated bill details from T24.
Method: Custom Verb
URL: /services/data/v1/LoanPayoff/objects/LoanSimulateObject
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

activityId (Mandatory)

Specifies the T24 activity ID.

productId (Mandatory)

Specifies the T24 product ID.

arrangementId (Mandatory)

Specifies the T24 arrangement ID.

effectiveDate (Mandatory)

Specifies the date to simulate and calculate the loan payoff amount.

billType (Mandatory)

Specifies the type of the bill such as PAYOFF or T24.

{
    "activityId": "LENDING-CALCULATE-PAYOFF",
    "productId": "MORTGAGE",
    "arrangementId": "AA1910770HQK",
    "effectiveDate" : "20200623",
    "billType": "PAYOFF"
}
Response:

Parameters

totalAmount

Specifies the total amount that has been simulated.

propertyName

Specifies the name of the property.

interestAmount

Specifies the interest amount that has been simulated.

{
   "totalAmount":144309.12,
   "opstatus":0,
   "properties":[
      {
         "propertyName":"Account",
         "interestAmount":144054.88
      
},
      {
         "propertyName":"Principal Interest",
         "interestAmount":129.24
      
},
      {
         "propertyName":"Principal Decrease Fee",
         "interestAmount":25
      
},
      {
         "propertyName":"Payoff Fee",
         "interestAmount":100
      
}
   
],
   "httpStatusCode":0
}
Error Code(s):
  • Error Code: 20041
    Error Message: Backend Failed.
  • Error Code: 20001
    Error Message: Invalid Payload.
  • Error Code: 20003
    Error Message: No records were found that matched the selection criteria.
  • Error Code: 20400
    Error Message: Internal Error.
  • Error Code: 20043
    Error Message: Unable to read value for number of days from fabric configuration.
Associated T24 APIs:
  • T24-BasePath/ infinity-retail-api/api/v1.1.0/holdings/loans/{ArrangementID}/bills?billType=PAYOFF&paymentDate=20200623

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?