Webhooks

Webhooks are server callbacks from Cashfree Payments. These event-based notifications are received when a specific event related to the loan management journey occurs.

The configuration of webhook events completes the Lending integration with Cashfree Payments. Contact your account manager to configure webhooks. You receive an email with the webhook endpoints in your registered email address.

You receive webhooks as updates after a request from your side. For example, you create a loan using the Create Loan API and receive a webhook regarding the status of the loan within the line of credit.

The response time of each webhook event is different. Cashfree Payments notifies you once we get updates from the lender about the loan management journey status.


Webhook Events(Line)

Lending Gateway webhooks enable you to receive updates about the status of line of credit during the loan management process. Below is the list of Lending Gateway - Loan Management System webhook events:

EventDescription
PENDINGThe line of credit is pending.
LIVEThe line of credit is live and available for loan requests.
FREEZEDThe line of credit is in a freezed state.
​CLOSEDThe line of credit is closed.

Sample Payload

You can view the sample payload for a line status below:

{
  "line_id": "A123",
  "status": "INITIATED",
  "sanctioned_amount": 300000,
  "sanctioned_date": "2022-07-06T00:00:00",
  "loan_product": "Kamlesh",
  "utilized_line": 300000,
  "unutilized_line": 300000,
  "tenure_in_months": 12,
  "rate_of_interest": 300000,
  "processing_fee": 300000,
  "total_drawdowns": 12,
  "total_overdue": 12,
  "interest_overdue": 300000,
  "total_disbursed_loans": 12,
  "total_closed_loans": 12,
  "total_loan_requests": 12,
  "line_expiry_date": "2022-07-06T00:00:00",
  "added_on": "2022-07-06T00:00:00",
  "last_updated_on": "2022-07-06T00:00:00"
}

Payload Parameter Description

The table below lists the different parameters that might be in the response for a line of credit and its descriptions:

ParameterDescription
line_idIt is the unique ID created by Cashfree Payments and shared to you when a line of credit is approved for the customer. The line ID represents a particular line of credit. Note it down for future references.
statusIt is the status of the line of credit. The different statuses are INITIATED, PENDING, LIVE, FREEZED, CLOSED.
sanctioned_amountIt is the amount sanctioned for the line of credit.
sanctioned_dateThe is the date when the line of credit was sanctioned.
loan_productIt represents the type of loan that the user can withdraw from the line of credit.
utilized_lineIt is the amount borrowed by the customer from the sanctioned line of credit to pay for the invoice raised by the distributor/dealer.
unutilized_lineIt is the remaining amount in the line of credit for the customer to borrow and pay for future invoices.
tenure_in_monthsIt represents the amount of time to repay the borrowed money.
rate_of_interestIt is the amount charged as interest for the borrowed money.
processing_feeIt is the fee levied for processing the line of credit.
total_drawdownsIt represents the number of times the customer withdrew the available money.
total_overdueIt is the number of payment overdues by the customer for the drawdowns.
interest_overdueIt is the overdue interest amount by the customer for the drawdown.
total_disbursed_loansIt represents the number of loans disbursed to the customer.
total_closed_loansIt represents the number of loans closed by the customer.
total_loan_requestsIt represents the number of loan requests on behalf of the customer.
line_expiry_dateIt is the expiry date of the line of credit.
added_onIt represents the entry creation date.
last_updated_onIt represents the time of the latest record updation.

Webhook Events(Loan)

Lending Gateway webhooks enable you to receive updates about the created loan within the line of credit during the loan management process. Below is the list of Lending Gateway - Loan Management System webhook events:

EventDescription
PENDINGThe requested loan is in a pending state.
APPROVEDThe requested loan is approved by the lending partner.
CLOSEDThe loan from the line of credit is closed.
REJECTEDThe requested loan is rejected by the lending partner.
DISBURSEDThe requested loan is disbursed to the customer.

{
  "loan_id": "A123",
  "line_id": "A123",
  "status": "INITIATED",
  "loan_amount": 300000,
  "delayed_payment_in_days": "2022-07-06T00:00:00",
  "closure_date": "2022-07-06T00:00:00",
  "instalment_date": "2022-07-06T00:00:00",
  "instalment_amount": 300000,
  "payment_date": "2022-07-06T00:00:00",
  "last_updated_on": "2022-07-06T00:00:00"
}

Payload Parameter Description

The table below lists the different parameters that might be in the response for a loan within the line of credit and its descriptions:

ParameterDescription
loan_idIt is the unique ID created by Cashfree Payments and shared to you when the loan is approved for the customer. The loan ID represents a particular loan within the line of credit. Note it down for future references.
line_idIt is the unique ID created by Cashfree Payments and shared to you when the line of credit is approved for the customer. The line ID represents a particular line of credit. Note it down for future references.
statusIt is the status of the loan within the line of credit. The different statuses are INITIATED, PENDING, APPROVED, CLOSED, REJECTED, DISBURSED.
loan_amountIt represents the loan amount requested on behalf of the customer to pay for the invoice raised by the distributor/dealer.
delayed_payment_in_daysIt represents the number of days delayed to pay the loan amount by the customer.
closure_dateIt represents the date when the loan was closed.
instalment_dateIt represents the date for the payment of each instalment.
instalment_amountIt represents the instalment amount that you pay over a period of time to repay the borrowed amount.
payment_dateIt represents the date when the payment was made.
last_updated_onIt represents the time of the latest record updation.