Webhooks

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:

Event	Description
PENDING	The line of credit is pending.
LIVE	The line of credit is live and available for loan requests.
FREEZED	The line of credit is in a freezed state.
CLOSED	The 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:

Parameter	Description
line_id	It 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.
status	It is the status of the line of credit. The different statuses are INITIATED, PENDING, LIVE, FREEZED, CLOSED.
sanctioned_amount	It is the amount sanctioned for the line of credit.
sanctioned_date	The is the date when the line of credit was sanctioned.
loan_product	It represents the type of loan that the user can withdraw from the line of credit.
utilized_line	It is the amount borrowed by the customer from the sanctioned line of credit to pay for the invoice raised by the distributor/dealer.
unutilized_line	It is the remaining amount in the line of credit for the customer to borrow and pay for future invoices.
tenure_in_months	It represents the amount of time to repay the borrowed money.
rate_of_interest	It is the amount charged as interest for the borrowed money.
processing_fee	It is the fee levied for processing the line of credit.
total_drawdowns	It represents the number of times the customer withdrew the available money.
total_overdue	It is the number of payment overdues by the customer for the drawdowns.
interest_overdue	It is the overdue interest amount by the customer for the drawdown.
total_disbursed_loans	It represents the number of loans disbursed to the customer.
total_closed_loans	It represents the number of loans closed by the customer.
total_loan_requests	It represents the number of loan requests on behalf of the customer.
line_expiry_date	It is the expiry date of the line of credit.
added_on	It represents the entry creation date.
last_updated_on	It 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:

Event	Description
PENDING	The requested loan is in a pending state.
APPROVED	The requested loan is approved by the lending partner.
CLOSED	The loan from the line of credit is closed.
REJECTED	The requested loan is rejected by the lending partner.
DISBURSED	The 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:

Parameter	Description
loan_id	It 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_id	It 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.
status	It is the status of the loan within the line of credit. The different statuses are INITIATED, PENDING, APPROVED, CLOSED, REJECTED, DISBURSED.
loan_amount	It represents the loan amount requested on behalf of the customer to pay for the invoice raised by the distributor/dealer.
delayed_payment_in_days	It represents the number of days delayed to pay the loan amount by the customer.
closure_date	It represents the date when the loan was closed.
instalment_date	It represents the date for the payment of each instalment.
instalment_amount	It represents the instalment amount that you pay over a period of time to repay the borrowed amount.
payment_date	It represents the date when the payment was made.
last_updated_on	It represents the time of the latest record updation.