Skip to main content

Loan Action : Cancellation

Cancellation

Screenshot 2023-04-22 at 12.48.19 AM.png

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

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


GET Cancellation

This API is used for retrieving all the cancellation 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 = cancellation
loanId* Integer -
* required Param

Response: 200

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

Fetch Data for Cancellation

Upon fetching the SynoFin Cancellation API. The user can choose the cancellation 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 Cancellation
  2. Master data for Cancellation

POST Data For Loan Action

To obtain data for Cancellation, utilise this API.

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

Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Loan Actions - Cancellation

Request Body

Response: 200




Loan Cancellation

{
    "loan_id": "integer",
    "request_id": "loan_cancellation"
}
{
   "response": true,
   "data": {
      "total_dues": 0,
      "net_dues": 0,
      "net_refund": 0
   },
   "error": null
}



Receipt Cancellation

{
    "loan_id": "integer",
    "request_id": "receipt_cancellation"
}
{
   "response": true,
   "data": {
      "receipt_cancellation": [],
      "receipt_cancellation_date": "yyyy-MM-dd"
   },
   "error": null
}



Payment Cancellation

{
    "loan_id": "1455",
    "request_id": "payment_cancellation"
}
{
   "response": true,
   "data": {
      "payment_cancellation": [],
      "payment_cancellation_date": "yyyy-MM-dd"
   },
   "error": null
}



Rescheduling

Cancellation

{
    "loan_id": "1455",
    "request_id": "rescheduling_cancellation"
}
{
  "response": true,
  "data": {
    "rescheduling_cancellation": [],
    "rescheduling_cancellation_date": "yyyy-MM-dd"
  },
  "error": null
}








Adhoc Cancellation

{
    "charges": [
        {
            "loan_charge_id": 0,
            "transaction_date": "14/02/2024",
            "due_date": "14/02/2024",
            "type": "string",
            "charge_name": "string Money",
            "charge_code": "string",
            "original_amount": 0,
            "paid_amount": 0,
            "waiver_amount": 0,
            "amount_in_process": 0,
            "charge_state": "0",
            "source": "string",
            "payment_status": "string"
        }
    ]
}
{
    "response": true,
    "data": {
        "charges": [
            {
                "loan_charge_id": 0,
                "transaction_date": "14/02/2024",
                "due_date": "14/02/2024",
                "type": "string",
                "charge_name": "string",
                "charge_code": "string",
                "original_amount": 0,
                "paid_amount": 0.0,
                "waiver_amount": 0.0,
                "amount_in_process": 0.0,
                "charge_state": "string",
                "source": "string",
                "payment_status": "string"
            }
        ]
    },
    "error": null
}




Foreclosure Cancellation

{
    "foreclosure_service_request": null,
    "foreclosure_charge": null,
    "foreclosure_cancellation_date": "yyyy-MM-dd"
}
{
    "response": true,
    "data": {
        "foreclosure_service_request": null,
        "foreclosure_charge": null,
        "foreclosure_cancellation_date": "yyyy-MM-dd"
    },
    "error": null
}

POST Master Data for Cancellation

To obtain Master data for cancellation, utilise this API.

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

Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Loan Actions - Cancellation

Request -

Request Body

Response: 200





Loan Cancellation

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



Receipt Cancellation

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



Payment Cancellation

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



Rescheduling

Cancellation

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



Adhoc Cancellation

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



Foreclosure Cancellation

No Master Data
{
    "response": true,
    "data": [
        {}
    ],
    "error": null
}

Fetch Charges for Cancellation

Whenever charges are required to be fetched or charges are applicable for certain loan actions, these APIs are utilised to get cancellation costs.

GET Charge for Part Payment

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

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

Request Type: GET
Authorization: Bearer Token


Loan Action - Cancellation

Request -

Query Parameter


Response : 200
Key Data Type Value










Loan Cancellation

 serviceReqId* String Fixed :loan_cancellation {
   "response": true,
   "data": {
      "charges": [
         {
            "chargesDefinitionId": 0,
            "description": "string",
            "currency": null,
            "computedOn": "",
            "computedAmount": 0,
            "chargeRate": null,
            "chargeType": "string",
            "isActive": false,
            "isTaxApplicable": true,
            "computedOnAmount": null,
            "amountBased": null,
            "rateBased": null,
            "effectiveChargeRate": null,
            "taxableAmount": 0.0,
            "taxAmount": 0.0,
            "chargeCode": "string",
            "chargeAmount": 0
         }
      ]
   },
   "error": null
}
loanId* Integer -
*required parameter

Saving / Initiation Request for Loan Action (Cancellation)

These are the APIs that are used to save loan cancellations 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 Cancellation for the selected cancellation 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 - Cancellation

Request Body

Response: 200







Loan Cancellation

{
    "service_request_type": "loan_cancellation",
    "service_request_subtype": "0",
    "loan_id": "0",
    "request_data": {
        "total_dues": "0",
        "net_refund": "0",
        "net_dues": "0",
        "reason": "0",
        "charges": [ ],
        "Cancellation_type_list": "string",
        "uploadFile": "",
        "remarks": "",
        "transaction_date": "2023-04-15"
    },
    "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "error": null
}



Receipt Cancellation

{
    "service_request_type": "receipt_cancellation",
    "service_request_subtype": "0",
    "service_type": "",
    "loan_id": "0",
    "request_data": {
        "receipt_cancellation": [ ],
        "receipt_cancellation_date": "2024-02-14",
        "number_of_instuments": 0,
        "reason": "0",
        "total_amount": 0,
        "transaction_date": "2024-02-14"
    },
    "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "error": null
}



Payment Cancellation

{
  "service_request_type": "payment_cancellation",
  "service_request_subtype": "2",
  "service_type": "",
  "loan_id": "91",
  "request_data": {
    "payment_cancellation_date": "2024-03-16",
    "reason": "1452",
    "payment_cancellation": [
      {
        "payment_id": 19
      }
    ],
    "uploadFile": "",
  },
  "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "error": null
}



Rescheduling

Cancellation

{
    "service_request_type": "charge_cancellation",
    "service_request_subtype": "0",
    "service_type": "",
    "loan_id": "0",
    "request_data": {
        "rescheduling_cancellation": "",
        "rescheduling_cancellation_date": "2024-02-14",
        "number_of_instuments": 0,
        "reason": "0",
        "total_amount": 0,
        "charges": [ ],
        "transaction_date": "2024-02-14"
    },
    "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "error": null
}








Adhoc Cancellation

{
    "service_request_type": "charge_cancellation",
    "service_request_subtype": "0",
    "service_type": "",
    "loan_id": "0",
    "request_data": {
        "charge_cancellation": "",
        "adhoc_cancellation_date": "2024-02-14",
        "number_of_instuments": 0,
        "reason": "0",
        "total_amount": 0,
        "charges": [ ],
        "transaction_date": "2024-02-14"
    },
    "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "error": null
}




Foreclosure Cancellation

{
    "service_request_type": "foreclosure_cancellation",
    "service_request_subtype": "0",
    "loan_id": "0",
    "request_data": {
        "foreclosure_charge": "",
        "foreclosure_service_request": "",
        "foreclosure_cancellation_date": "2023-04-15",
        "transaction_date": "2023-04-15"
    },
    "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "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