Skip to main content

Partial Loan Cancellation

GET Partial Loan Cancellation

When a client makes a partial payment before the due date and to modify the payment accordingly, this API is utilised. The System need to follow two steps:

Step 1 : Create Receipt for Partial Cancellation
Step 2 : Perform Part Payment for Partial Cancellation


Step 1 : Create Receipt for Partial Cancellation

GET Receipt Details

This API is used to fetch receipts for partial loan cancellations.

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

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

Response: 200

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



POST Data For Loan Action (Receipt)

To obtain data for Receipt, utilise this API.

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

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter
Request Body * required Param


{
    "loan_id": integer,
    "request_id": "receipt"
}


Response: 200

{
   "response": true,
   "data": {
      "outstanding_charges": [ ],
      "date_of_receipt": "yyyy-MM-dd",
      "addition_in_excess_money": integer
   },
   "error": null
}



POST Master Data for Receipt

To obtain Master data for Receipt, utilise this API.

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

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Request Body * required Param


[
   {
      "type": "payment_mode"
   },
   {
      "type": "receipt_purpose"
   },
   {
      "type": "payment_bank"
   },
   {
      "type": "bounce_reason_for_nach"
   }
]


Response: 200

{
   "response": true,
   "data": [
      {
         "payment_mode": {
            "values": [
               {
                  "key": "string",
                  "value": "string"
               }
            ],
            "parent": null
         },
         "bounce_reason_for_nach": {
            "values": [
               {
                  "key": "string",
                  "value": "string"
               }
            ],
            "parent": null
         },
         "receipt_purpose": {
            "values": [
               {
                  "key": "string",
                  "value": "string"
               }
            ],
            "parent": null
         },
         "payment_bank": {
            "values": [
               {
                  "key": "string",
                  "value": "string"
               }
            ],
            "parent": null
         }
      }
   ],
   "error": null
}

POST  Save Receipt

Create a receipt for "Excess Money" once all the details have been collected by the application and store the receipt using this API.

Screenshot 2023-04-18 at 3.58.06 PM.png


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

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Request Body * required Param


{
   "service_request_type": "receipt",
   "service_request_subtype": "integer",
   "service_type": "",
   "loan_id": "integer",
   "request_data": {
      "date_of_receipt": "2024-01-31",
      "receipt_amount": "integer",
      "cash_receipt_number": "",
      "payment_mode": "integer",
      "transaction_date": "2024-01-31",
      "received_from": "String",
      "receipt_purpose": "excess_money",
      "instrument_date": "2024-01-31",
      "instrument_number": "",
      "transaction_reference": "",
      "payment_bank": "",
      "upi": "",
      "instrument_bank_name": "",
      "bank_account_number": "",
      "fund_transfer_number": "",
      "ifsc": "",
      "instrument_bank_address": "",
      "is_nach": true,
      "bounce_reason_for_nach": "",
      "addition_in_excess_money": "0",
      "bank_recon_ref_identifier": "",
      "auto_allocated": "Yes",
      "receipts_allocation": "",
      "remarks": "",
      "receivables": []
   },
   "service_request_id": ""
}

Response: 200

{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": integer
    },
    "error": null
}



Step 2 : Perform Part Payment for Partial Cancellation

GET Rescheduling Details

This API is used to get details for rescheduling receipts for partial loan cancellations. Here user will be getting multiple function but for Loan partial cancellation we user have to choose Part-Payment.

Screenshot 2023-04-13 at 12.14.53 PM.png

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

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

Response: 200

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


GET Charge for Part Payment

To obtain data for Part Payment charges, utilise this API.

URL: {{base_url}}/charges/v1/getChargeForServiceRequest

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

Response: 200

{
  "response": true,
  "data": {
    "charges": [ ]
  },
  "error": null
}


POST Data For Loan Action (Receipt)

To obtain data for Part Payment, utilise this API.

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

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter
Request Body * required Param


{
    "loan_id": integer,
    "request_id": "part_payment"
}


Response: 200

{
    "response": true,
    "data": {
        "installment_plan": "string",
        "frequency": "string",
        "anchor_type": "string",
        "anchor_rate": number,
        "spread": number,
        "excess_amount": number,
        "adjusted_charges": [ ],
        "adjusted_installments": [],
        "effective_date": "yyyy-MM-dd",
        "current_due_day": integer,
        "installment_amount": number,
        "balance_installment_amount": number,
        "total_tenure": integer,
        "tenure_remaining": integer,
        "repayment_start_date": "yyyy-MM-dd",
        "capitalize_overdue_installment": number,
        "capitalize_overdue_charges": number,
        "total_capitalize_amount": number
    },
    "error": null
}


POST Master Data for Receipt

To obtain Master data for Part Payment, utilise this API.

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

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Request Body * required Param


[
[
    {
        "type": "source_of_fund"
    },
    {
        "type": "treatment_type"
    },
    {
        "type": "reason",
        "parent": "service_request_id",
        "parent_id": "part_payment"
    }
]


Response: 200

{
    "response": true,
    "data": [
        {
            "reason": {
                "values": [
                    {
                        "key": "integer",
                        "value": "string"
                    }
                ],
                "parent": null
            },
            "source_of_fund": {
                "values": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ],
                "parent": null
            },
            "treatment_type": {
                "values": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ],
                "parent": null
            }
        }
    ],
    "error": null
}

POST  Save Part Payment Details

Create a part-payment once all the details have been collected by the application and store the part-payment details using this API.

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

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Request Body * required Param


{
   "service_request_type": "part_payment",
   "service_request_subtype": "stringv",
   "service_type": "",
   "loan_id": "string",
   "request_data": {
      "effective_date": "2024-01-31",
      "gross_pre_pay_amount": "string",
      "excess_amount": integer,
      "eligible_pre_pay_amount": "string",
      "source_of_fund": "string",
      "treatment_type": "string",
      "balance_installment": "",
      "installment_amount": integer,
      "reason": "string",
      "uploadFile": "",
      "adjusted_charges": [],
      "adjusted_installments": [],
      "charges": [],
      "repayment_schedule_table": "string",
      "remarks": "string",
      "chargeRate": 4,
      "transaction_date": "2024-01-31"
   },
   "service_request_id": ""
}

Response: 200

{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": integer
    },
    "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

No Comments
Back to top