Skip to main content

Loan Action : Closure

Closure

Screenshot 2023-04-22 at 2.49.13 AM.png

The Synofin API's Loan Closure Action is linked to various closure that a user may initiate in accordance with their requirements. This feature involves different step which are :

  1. Retrieving Cancellation (Closure)
  2. Retrieving Data for Loan Action (Closure)
  3. Saving / Initiation Request for Loan Action (Closure)
  4. Approving / Rejection Service Request for Loan Action (Closure)


GET Closure

This API is used for retrieving all the closure details for the specified Loan Id. 

URL: {{base_url}}/loan-management/v1/service-request/status

Request
Request Type: GET
Authorization: Bearer Token
Query Parameter
Key Data Type Value
request* String Fixed = closure
loanId* Integer -
* required Param

Response: 200

{
    "response": true,
    "data": true,
    "error": null
}

Fetch Data for Closure

Upon fetching the SynoFin losure API. The user can choose the closure they must carry out in order to fulfil their demand at this point. 
Consequently, we use following APIs to retrieve the Data for the selected cancellation for the specified Loan Id.

  1. Data for Loan Action Closure
  2. Master data for Closure

POST Data For Loan Action

To obtain data for closure, utilise this API.

URL: {{base_url}}/loan-modification/v1/service-request/getDataForLoanActions

Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Loan Actions - ClosureForeClosure

Request Body

Response: 200

Fore Closure

 

{
    "loan_id": "integer",
 
    "request_id": "foreclosure"
,
    "loan_id": "134",
    "foreclosure_options": {
        "closure_date": "2024-10-08",
        "interest_till_date": "2024-10-08",
        "last_due_date": "2023-09-05",
        "closure_rate": "5",
        "total_waived_amount": [
            "0",
            "504",
            "2000",
            "0"
        ],
        "principal_waived": "2000"
    }

}
Response 
{
 
    "response": true,
 
    "data": {
 
        "balance_tenure": 0,
 
        "total_dues": 0,
 95411.11,
        "loan_service_charge_rate": 5.0,
 
        "loan_service_charge_amount": 0,
 1770.00,
        "refunds": 0,
 0.00,
        "principal_outstanding": 0,
 30000.00,
        "unrealized_receipt": 0,
 0.00,
        "outstanding_charges": [
            {
                "charge_id": 772,
                "charge_label": "Late Payment Penalty",
                "total_outstanding_amount": null,
                "type": "charges",
                "original_amount": 65641.11,
                "charge_definition_id": null,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": "lpp",
                "outstanding_amount": 65641.11,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null
            },
            {
                "charge_id": -2,
                "charge_label": "Total Interest Outstanding",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": -2,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": null,
                "outstanding_amount": 504.0,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null
            },
            {
                "charge_id": -3,
                "charge_label": "Total Principal Outstanding",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": -3,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": null,
                "outstanding_amount": 30000.0,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null
            },
            {
                "charge_id": 0,
                "charge_label": "Foreclosure charge",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": null,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": "fore_closure_charge",
                "outstanding_amount": 1770.0,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null
            }
        ],
 
        "interest_due": 0.0,
 
        "pending_installment_amount": 30504.0,
 
        "total_waived_amount": 0.0,
 
        "per_day_interest": 0.0,
 
        "next_installment_presentation_date": "2024-02-02T18:30:00.000+00:00",
 null,
        "excess_money": 0,
 0.00,
        "net_closure_amount": 0,
 95411.11,
        "last_due_date": "03-01-2024"05-09-2023",
 
        "overdue_principal": 0.0,
 
        "lockin_period": 0.0,
 
        "total_waiver_amount": null,
 2504.0,
        "balance_principal": 0.0,
        "advance_installment": 0.00,
        "settled_amount": 28000.0,
        "write_off_amount": 2000.0
 
    },
 
    "error": null
null,
    "timestamp": "2024-10-08T14:20:17.459+00:00"
}

Maturity Closure

{
    "loan_id": "integer",
    "request_id": "maturity_closure"
}
{
   "response": true,
   "data": {
      "balance_tenure": 0,
      "total_dues": 0,
      "refunds": 0,
      "principal_outstanding": 0,
      "unrealized_receipt": 0,
      "outstanding_charges": [],
      "interest_due": 0,
      "pending_installment_amount": 0,
      "total_waived_amount": 0,
      "per_day_interest": 0,
      "next_installment_presentation_date": "2024-02-02T18:30:00.000+00:00",
      "excess_money": 0,
      "net_closure_amount": 0,
      "last_due_date": "03-01-2024",
      "overdue_principal": 0,
      "balance_principal": 0
   },
   "error": null
}

POST Master Data for Closure

To obtain Master data for closure, utilise this API.

URL: {{base_url}}/loan-management/v1/getMasterType

Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Loan Actions - Closure

Request -

Request Body

Response: 200

Fore Closure

[
   {
      "type": "reason",
      "parent": "service_request_id",
      "parent_id": "foreclosure"
   },
   {
      "type": "waiver_users"
   }
]
{
   "response": true,
   "data": [
      {
         "reason": {},
         "waiver_users": {}
      }
   ],
   "error": null
}

Maturity Closure

[
    {
        "type": "reason",
        "parent": "service_request_id",
        "parent_id": "maturity_closure"
    },
    {
        "type": "waiver_users"
    }
]
]
{
   "response": true,
   "data": [
      {
         "reason": {},
         "waiver_users": {}
      }
   ],
   "error": null
}

Saving / Initiation Request for Loan Action (Closure)

These are the APIs that are used to save loan closure or initiate service requests initiated by maker so that the checker can review them and then determine what they want to accomplish and either Approve or Reject the Request.

Consequently, we use following APIs to save or intiated the Loan Closure for the selected closure for the specified Loan Id.

POST Save Service Request

To save data for Cancellation, utilise this API.

URL: {{base_url}}/loan-modification/v1/service-request/save

Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Loan Actions - Closure

Request Body

Response: 200

Fore Closure

 
{
    "service_request_type": "foreclosure",
    "service_request_subtype": "2",
    "service_type": "",
    "loan_id": "134",
    "request_data": {
        "balance_tenure": "0",
        "total_dues": 32074,
        "unrealized_receipt": "0",
        "last_due_date": "05-09-2023",
        "closure_date": "2024-10-08",
        "interest_till_date": "2024-10-08",
        "loan_service_charge_rate": 5,
        "loan_service_charge_amount": 1770,
        "refunds": 0,
        "interest_due": 0,
        "balance_principal": "0",
        "principal_outstanding": 30000,
        "excess_money": "0",
        "advance_installment": "0",
        "per_day_interest": 0,
        "net_closure_amount": 32074,
        "lockin_period": 0,
        "reason": "1504",
        "closure_type": "",
        "waiver_users": "",
        "uploadFile": "",
        "total_waiver_amount": 65841.11,
        "is_write_off": false,
        "write_off_amount": 0,
        "settled_amount": 30000,
        "outstanding_charges": [
            {
                "charge_id": 772,
                "charge_label": "Late Payment Penalty",
                "total_outstanding_amount": null,
                "type": "charges",
                "original_amount": 65641.11,
                "charge_definition_id": null,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": "lpp",
                "outstanding_amount": 65641.11,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null,
                "waiver": "65641.11",
                "waiver_users": ""
            },
            {
                "charge_id": -2,
                "charge_label": "Total Interest Outstanding",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": -2,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": null,
                "outstanding_amount": 504,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null,
                "waiver": "200",
                "waiver_users": ""
            },
            {
                "charge_id": -3,
                "charge_label": "Total Principal Outstanding",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": -3,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": null,
                "outstanding_amount": 30000,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null,
                "waiver": "0",
                "waiver_users": ""
            },
            {
                "charge_id": 0,
                "charge_label": "Foreclosure charge",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": null,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": "fore_closure_charge",
                "outstanding_amount": 1770,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null,
                "waiver": "0",
                "waiver_users": ""
            }
        ],
        "remarks": "",
        "payment_on_hold_reason": "",
        "other_reason": "",
        "total_waived_amount": 0,
        "transaction_date": "2024-10-08"
    },
    "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "status": "initiated",
        "service_request_id": 0,
        "unique_transaction_number": null
    },
    "error": null
}

Maturity Closure

 
{
    "service_request_type": "maturity_closure",
    "service_request_subtype": "2",
    "service_type": "",
    "loan_id": "134",
    "request_data": {
        "balance_tenure": "0",
        "total_dues": 96145.11,
        "unrealized_receipt": "0",
        "last_due_date": "05-09-2023",
        "closure_date": "2024-10-08",
        "interest_till_date": "2024-10-08",
        "refunds": "0",
        "balance_principal": "0",
        "principal_outstanding": 30000,
        "excess_money": "0",
        "per_day_interest": "0",
        "interest_due": "0",
        "net_closure_amount": 96145.11,
        "reason": "1403",
        "upload_file": "",
        "waiver_users": "",
        "is_write_off": "",
        "write_off_amount": "0",
        "settled_amount": "0",
        "outstanding_charges": [
            {
                "charge_id": 772,
                "charge_label": "Late Payment Penalty",
                "total_outstanding_amount": null,
                "type": "charges",
                "original_amount": 65641.11,
                "charge_definition_id": null,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": "lpp",
                "outstanding_amount": 65641.11,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null,
                "waiver": "0",
                "waiver_users": ""
            },
            {
                "charge_id": -2,
                "charge_label": "Total Interest Outstanding",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": -2,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": null,
                "outstanding_amount": 504,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null,
                "waiver": "0",
                "waiver_users": ""
            },
            {
                "charge_id": -3,
                "charge_label": "Total Principal Outstanding",
                "total_outstanding_amount": null,
                "type": null,
                "original_amount": null,
                "charge_definition_id": -3,
                "excess_money_id": null,
                "loan_id": null,
                "disbursal_schedule_id": null,
                "charge_code": null,
                "outstanding_amount": 30000,
                "amount_in_process": null,
                "payment_status": null,
                "paid_amount": null,
                "total_paid_amount": null,
                "total_paid_amount_in_process": null,
                "paid_amount_in_process": null,
                "allocated_amount": null,
                "reason": null,
                "payment_date": null,
                "repayment_id": null,
                "balance_payable": null,
                "waiver": "0",
                "waiver_users": ""
            }
        ],
        "remarks": "",
        "payment_on_hold_reason": "",
        "other_reason": "",
        "transaction_date": "2024-10-08"
    },
    "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "status": "initiated",
        "service_request_id": 0,
        "unique_transaction_number": null
    },
    "error": null
}


Request Approval / Rejection 

The request must now be approved at the Request page, where users may examine requests and take action.

SynoFin - Request

Back to top