Skip to main content

Loan Action : Knock Off

Knock Off

Screenshot 2023-04-22 at 5.43.12 AM.png

The Synofin API's Loan Knock Off 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 (Knock Off)
  2. Retrieving Data for Loan Action (Knock Off)
  3. Saving / Initiation Request for Loan Action (Knock Off)
  4. Approving / Rejection Service Request for Loan Action (Knock Off)


GET Knock Off

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

Response: 200

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

Fetch Data for Knock Off

Upon fetching the SynoFin API. The user can choose the Knock Off 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 Knock Off for the specified Loan Id.

  1. Data for Loan Action Knock Off
  2. Master data for Knock Off

POST Data For Loan Action

To obtain data for Knock Off, utilise this API.

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

Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Loan Actions - Knock Off

Request Body

Response: 200

Knock Off

{
    "loan_id": "integer",
    "request_id": "knock_off"
}
{
  "response": true,
  "data": {
    "payables": [],
    "receivables": {
      "outstanding_charges": []
    },
    "businessDate": "2024-02-14"
  },
  "error": null
}

Cross Knock Off

{
    "loan_id": "integer",
    "request_id": "cross_knock_off"
}
{{
  "response": true,
  "data": {
    "payables": [],
    "loan_account_number": "string",
    "customer_type": "string",
    "customer_name": "string",
    "linked_loans": [
      {
        "loan_account_number": "string",
        "customer_name": "string",
        "customer_type": "string",
        "outstanding_charges": [],
        "loan_application_id": "0",
        "outstanding_installments": null
      }
    ]
  },
  "error": null
}

Reversal

{
    "loan_id": "integer",
    "request_id": "reversal"
}
{
    "response": true,
    "data": {
        "reversals": []
    },
    "error": null
}

POST Master Data for Knock Off

To obtain Master data for Knock Off, utilise this API.

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

Request Type: POST
Authorization: Bearer Token

Query Parameter
No parameter

Loan Actions - Knock Off

Request -

Request Body

Response: 200

Knock Off

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

Cross Knock Off

[
    {
        "type": "receivable_linked_loans"
    }
]
{
    "response": true,
    "data": [
        {
            "receivable_linked_loans": {
                "values": [],
                "parent": null
            }
        }
    ],
    "error": null
}

Reversal

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

Saving / Initiation Request for Loan Action (Knock Off)

These are the APIs that are used to save loan Knock Off 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 Knock Off for the selected Knock Off for the specified Loan Id.

POST Save Service Request

To save data for Knock Off, 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

Knock Off

{
  "service_request_type": "knock_off",
  "service_request_subtype": "0",
  "service_type": "",
  "loan_id": "0",
  "request_data": {
    "payables": [],
    "uploadFile": "",
    "remarks": "",
    "receivables": [],
    "addition_in_excess_money": 0,
    "transaction_date": "2024-02-14"
  },
  "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "error": null
}

Cross Knock Off

{
  "service_request_type": "cross_knock_off",
  "service_request_subtype": "2",
  "service_type": "",
  "loan_id": "0",
  "request_data": {
    "payable_linked_loans": "string",
    "payable_customer_type": "string",
    "payable_customer_name": "string",
    "payables": [],
    "receivable_linked_loans": "string",
    "receivable_customer_type": "string",
    "receivable_customer_name": "string",
    "receivables": {
      "loan_account_number": "string",
      "customer_name": "string",
      "customer_type": "string",
      "outstanding_charges": [],
      "loan_application_id": "0",
      "outstanding_installments": null
    },
    "addition_in_excess_money": 0,
    "transaction_date": "2024-02-14"
  },
  "service_request_id": ""
}
{
    "response": true,
    "data": {
        "result": null,
        "service_request_id": 0
    },
    "error": null
}

Reversal

{
  "service_request_type": "reversal",
  "service_request_subtype": "0",
  "service_type": "",
  "loan_id": "0",
  "request_data": {
    "reversals": [],
    "reason": "",
    "remarks": "",
    "transaction_date": "2024-02-14"
  },
  "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

No Comments
Back to top