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 Transact (T24) for a given lending arrangement. | 2020.07 |
| getBillDetailst24 | This API is used to fetch the simulated bill details from Transact. | 2020.07 |
createSimulationt24
| Description: | This API is used to create a loan simulation in Transact for a given lending arrangement. |
| Method: | POST |
| URL: | /services/data/v1/LoanPayoff/objects/LoanSimulateObject/createSimulationt24 |
| 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): |
|
| Associated T24 APIs: |
|
| Enterprise Provider: | Transact |
| Enterprise API: | {Base_URL}/api/v1.0.0/holdings/simulationCapture/{ArrangementID} |
| Transact Artifact: | AA.SIMULATION.CAPTURE,AA.API.GENERIC.1.0.0 |
getBillDetailst24
| Description: | This API is used to fetch the simulated bill details from Transact. |
| Method: | Custom Verb |
| URL: | /services/data/v1/LoanPayoff/objects/LoanSimulateObject/getBillDetailst24 |
| 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): |
|
| Associated T24 APIs: |
|
| Enterprise Provider: | Transact |
| Enterprise API: | {Base_URL}/api/v1.1.0/holdings/loans/{ArrangementID}/bills |
| Transact Artifact: | AA.API.LOAN.BILL.DETAILS.1.1.0 |
In this topic