Webhooks

Webhooks are server callbacks to your server from Cashfree Payments. These event-based notifications are received when a specific event related to the loan origination 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 lead using the Create Lead API and receive a webhook regarding the status of the data duplication process.

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


Webhook Events

Lending Gateway webhooks enable you to receive updates about all event-driven activities during the loan origination process. Below is the list of Lending Gateway webhook events:

EventsNotifications
DEDUPE_SUCCESSThe data duplication process is a success. The system did not find any existing data on the created lead.
DEDUPE_FAILThe data duplication process identifies existing data of the created lead.
FAILEDAt any time during the loan origination journey, this webhook is received.
ACCEPT_BUSINESS_DOCUMENTAfter the lender approves the required business documents upload of the specific lead ID for review, this webhook is received.
​OFFER_FLOATEDThe lender reviews the documents and floats an offer for the specific lead ID.
ACCEPT_KYC_DOCUMENTAfter the lender approves the personal documents upload of the specific lead ID for review, this webhook is received.
LOAN_APPROVEDThe lender approves the loan after the selection of the loan offer for the specific lead ID.

DEDUPE_SUCCESS​

You receive this webhook event after the data duplication process is a success. It is a success only when the process finds no existing data of the details provided using the Create Lead API. Find the sample payload of the webhook event below:

{
  "version": 1,
  "webhook_type": "LEAD",
  "event_time": "2023-02-01T17:36:06.097",
  "payload": {
    {
  "addedOn": "2023-02-09T12:45:15.836Z",
  "business_details": {
    "annual_business_revenue": 15000000,
    "business_address": {
      "address_line1": "3058,MP road,Iyya",
      "address_line2": "Green Glen Layout,Bellandur",
      "city": "Chennai",
      "pincode": "600056",
      "state": "Tamil Nadu"
    },
    "business_name": "Kenneth Medicals",
    "business_type": "SOLE_PROPRIETORSHIP",
    "company_pan": "DOCPX3423A",
    "date_of_incorporation": "2023-02-05T00:00:00.000Z",
    "gstin": "12DWWPB9503H1Z3",
    "number_of_partners_directors": 2,
    "udyog_aadhaar": "123412341234"
  },
  "customer_id": "4a00a3ee-3c8f-4afe-999e-6c931ee398ef",
  "lead_id": "new_lead_test_1",
  "loan_details": {
    "loan_amount": 100000,
    "loan_sub_type": "SUPPLY_CHAIN_FINANCING",
    "loan_tenure_in_months": 12,
    "loan_type": "BUSINESS",
    "purpose": "Working Capital"
  },
  "personal_details": {
    "aadhaar_number": "123124434343",
    "dob": "1974-08-31T00:00:00.000Z",
    "email": "[email protected]",
    "first_name": "kennetj",
    "gender": "MALE",
    "last_name": "kennetj",
    "mobile_number": "9840711948",
    "pan_card": "ACDPF9865L",
    "personal_address": {
      "address_line1": "Bizz 3058,MP road,Iyya",
      "address_line2": "Green Glen Layout,Bellandur",
      "city": "Chennai",
      "pincode": "600056",
      "state": "Tamil Nadu"
    }
  },
  "status": "DEDUPE_SUCCESS"
}
  }

DEDUPE_FAIL

You receive this webhook event after the data duplication process finds any existing data of the details provided using the Create Lead API. The user journey for the particular lead ID ends here. Find the sample payload of the webhook event below:

{
  "version": 1,
  "webhook_type": "LEAD",
  "event_time": "2023-02-01T17:58:09.560",
  "payload": {
    {
  "addedOn": "2023-02-09T12:45:15.836Z",
  "business_details": {
    "annual_business_revenue": 15000000,
    "business_address": {
      "address_line1": "3058,MP road,Iyya",
      "address_line2": "Green Glen Layout,Bellandur",
      "city": "Chennai",
      "pincode": "600056",
      "state": "Tamil Nadu"
    },
    "business_name": "Kenneth Medicals",
    "business_type": "SOLE_PROPRIETORSHIP",
    "company_pan": "DOCPX3423A",
    "date_of_incorporation": "2023-02-05T00:00:00.000Z",
    "gstin": "12DWWPB9503H1Z3",
    "number_of_partners_directors": 2,
    "udyog_aadhaar": "123412341234"
  },
  "customer_id": "4a00a3ee-3c8f-4afe-999e-6c931ee398ef",
  "lead_id": "new_lead_test_1",
  "loan_details": {
    "loan_amount": 100000,
    "loan_sub_type": "SUPPLY_CHAIN_FINANCING",
    "loan_tenure_in_months": 12,
    "loan_type": "BUSINESS",
    "purpose": "Working Capital"
  },
  "personal_details": {
    "aadhaar_number": "123124434343",
    "dob": "1974-08-31T00:00:00.000Z",
    "email": "[email protected]",
    "first_name": "kennetj",
    "gender": "MALE",
    "last_name": "kennetj",
    "mobile_number": "9840711948",
    "pan_card": "ACDPF9865L",
    "personal_address": {
      "address_line1": "Bizz 3058,MP road,Iyya",
      "address_line2": "Green Glen Layout,Bellandur",
      "city": "Chennai",
      "pincode": "600056",
      "state": "Tamil Nadu"
    }
  },
  "status": "DEDUPE_FAIL"
}
  }

FAILED

At any time during the loan origination journey, this webhook is received. You can find the reason for the failure in the remark parameter. Find the sample payload of the webhook event below:

{
    "addedOn": "2023-02-27T16:38:41.144",
    "business_details": {
        "business_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        },
        "business_name": "Daruwala",
        "business_type": "PARTNERSHIP_FIRM",
        "company_pan": "HKXPS5497B",
        "date_of_incorporation": "2023-02-14",
        "number_of_partners_directors": 1
    },
    "customer_id": "65140342-639e-428c-aeb2-ad30c6bf885a",
    "documents": [
        {
            "addedOn": "2023-02-27T16:42:48.514",
            "doc_type": "BANK_STATEMENT",
            "document_id": "1677496365615",
            "status": "VERIFICATION_PENDING"
        },
        {
            "addedOn": "2023-02-27T16:42:54.419",
            "doc_type": "GST_RETURN",
            "document_id": "1677496371998",
            "status": "VERIFICATION_PENDING"
        }
    ],
    "lead_id": "cf_lead_1677496119001",
    "loan_details": {
        "loan_amount": 278149,
        "loan_sub_type": "SUPPLY_CHAIN_FINANCING",
        "loan_tenure_in_months": 12,
        "loan_type": "BUSINESS",
        "purpose": "Working Capital"
    },
    "personal_details": {
        "dob": "2023-02-08",
        "email": "[email protected]",
        "first_name": "Saurav",
        "gender": "MALE",
        "last_name": "Bhardwaj",
        "mobile_number": "9484848444",
        "pan_card": "AKAPJ5349R",
        "personal_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        }
    },
    "remarks": "age : Saurav Age is 0 which is not between 25 and 60",
    "status": "FAILED"
}

ACCEPT_BUSINESS_DOCUMENT

You receive this webhook event as a notification to upload the required business documents of the lead using the Upload Documents API. Find the sample payload of the webhook event below:

{
  "version": 1,
  "webhook_type": "LEAD",
  "event_time": "2023-02-01T17:39:39.649791",
  "payload": {
    "addedOn": "2023-02-27T16:38:41.144",
    "business_details": {
        "business_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        },
        "business_name": "Daruwala",
        "business_type": "PARTNERSHIP_FIRM",
        "company_pan": "HKXPS5497B",
        "date_of_incorporation": "2023-02-14",
        "number_of_partners_directors": 1
    },
    "customer_id": "65140342-639e-428c-aeb2-ad30c6bf885a",
    "documents": [
        {
            "addedOn": "2023-02-27T16:42:48.514",
            "doc_type": "BANK_STATEMENT",
            "document_id": "1677496365615",
            "status": "VERIFICATION_PENDING"
        },
        {
            "addedOn": "2023-02-27T16:42:54.419",
            "doc_type": "GST_RETURN",
            "document_id": "1677496371998",
            "status": "VERIFICATION_PENDING"
        }
    ],
    "lead_id": "cf_lead_1677496119001",
    "loan_details": {
        "loan_amount": 278149,
        "loan_sub_type": "SUPPLY_CHAIN_FINANCING",
        "loan_tenure_in_months": 12,
        "loan_type": "BUSINESS",
        "purpose": "Working Capital"
    },
    "personal_details": {
        "dob": "2023-02-08",
        "email": "[email protected]",
        "first_name": "Saurav",
        "gender": "MALE",
        "last_name": "Bhardwaj",
        "mobile_number": "9484848444",
        "pan_card": "AKAPJ5349R",
        "personal_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        }
    },
    "remarks": "Business Document can be uploaded now for lead_id : cf_lead_1677496119001",
    "status": "ACCEPT_BUSINESS_DOCUMENT"
}

OFFER_FLOATED

You receive this webhook event as a notification that the lender floated a loan offer for the lead. You can find available loan offers for a specific lead ID using Get Offers API. You can select an offer for the lead using the Select Offer API. Find the sample payload of the webhook event below:

{
  "version": 1,
  "webhook_type": "LEAD",
  "event_time": "2023-02-01T17:44:03.245",
  "payload": {
    "addedOn": "2023-02-27T16:38:41.144",
    "business_details": {
        "business_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        },
        "business_name": "Daruwala",
        "business_type": "PARTNERSHIP_FIRM",
        "company_pan": "HKXPS5497B",
        "date_of_incorporation": "2023-02-14",
        "number_of_partners_directors": 1
    },
    "customer_id": "65140342-639e-428c-aeb2-ad30c6bf885a",
    "documents": [
        {
            "addedOn": "2023-02-27T16:42:48.514",
            "doc_type": "BANK_STATEMENT",
            "document_id": "1677496365615",
            "status": "VERIFICATION_PENDING"
        },
        {
            "addedOn": "2023-02-27T16:42:54.419",
            "doc_type": "GST_RETURN",
            "document_id": "1677496371998",
            "status": "VERIFICATION_PENDING"
        }
    ],
    "lead_id": "cf_lead_1677496119001",
    "loan_details": {
        "loan_amount": 278149,
        "loan_sub_type": "SUPPLY_CHAIN_FINANCING",
        "loan_tenure_in_months": 12,
        "loan_type": "BUSINESS",
        "purpose": "Working Capital"
    },
    "personal_details": {
        "dob": "2023-02-08",
        "email": "[email protected]",
        "first_name": "Saurav",
        "gender": "MALE",
        "last_name": "Bhardwaj",
        "mobile_number": "9484848444",
        "pan_card": "AKAPJ5349R",
        "personal_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        }
    },
    "remarks": "Offer is floated for lead_id : cf_lead_1677496119001",
    "status": "OFFER_FLOATED"
}

ACCEPT_KYC_DOCUMENT

This webhook event notifies you that the personal documents of the specific lead ID need to be uploaded using the Upload Documents API. Find the sample payload of the webhook event below:

{
  "version": 1,
  "webhook_type": "LEAD",
  "event_time": "2023-02-01T17:44:50.937",
  "payload": {
    "addedOn": "2023-02-27T16:38:41.144",
    "business_details": {
        "business_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        },
        "business_name": "Daruwala",
        "business_type": "PARTNERSHIP_FIRM",
        "company_pan": "HKXPS5497B",
        "date_of_incorporation": "2023-02-14",
        "number_of_partners_directors": 1
    },
    "customer_id": "65140342-639e-428c-aeb2-ad30c6bf885a",
    "documents": [
        {
            "addedOn": "2023-02-27T16:42:48.514",
            "doc_type": "BANK_STATEMENT",
            "document_id": "1677496365615",
            "status": "VERIFICATION_PENDING"
        },
        {
            "addedOn": "2023-02-27T16:42:54.419",
            "doc_type": "GST_RETURN",
            "document_id": "1677496371998",
            "status": "VERIFICATION_PENDING"
        }
    ],
    "lead_id": "cf_lead_1677496119001",
    "loan_details": {
        "loan_amount": 278149,
        "loan_sub_type": "SUPPLY_CHAIN_FINANCING",
        "loan_tenure_in_months": 12,
        "loan_type": "BUSINESS",
        "purpose": "Working Capital"
    },
    "personal_details": {
        "dob": "2023-02-08",
        "email": "[email protected]",
        "first_name": "Saurav",
        "gender": "MALE",
        "last_name": "Bhardwaj",
        "mobile_number": "9484848444",
        "pan_card": "AKAPJ5349R",
        "personal_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        }
    },
    "remarks": "Kyc Document can be uploaded now for lead_id : cf_lead_1677496119001",
    "status": "ACCEPT_KYC_DOCUMENT"
}

LOAN_APPROVED

This webhook notifies that the loan selected using the Select Offer API API for the specific lead ID is now approved. Find the sample payload of the webhook event below:

{
  "version": 1,
  "webhook_type": "LEAD",
  "event_time": "2023-02-01T17:45:20.777",
  "payload": {
    "addedOn": "2023-02-27T16:38:41.144",
    "business_details": {
        "business_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        },
        "business_name": "Daruwala",
        "business_type": "PARTNERSHIP_FIRM",
        "company_pan": "HKXPS5497B",
        "date_of_incorporation": "2023-02-14",
        "number_of_partners_directors": 1
    },
    "customer_id": "65140342-639e-428c-aeb2-ad30c6bf885a",
    "documents": [
        {
            "addedOn": "2023-02-27T16:42:48.514",
            "doc_type": "BANK_STATEMENT",
            "document_id": "1677496365615",
            "status": "VERIFICATION_PENDING"
        },
        {
            "addedOn": "2023-02-27T16:42:54.419",
            "doc_type": "GST_RETURN",
            "document_id": "1677496371998",
            "status": "VERIFICATION_PENDING"
        }
    ],
    "lead_id": "cf_lead_1677496119001",
    "loan_details": {
        "loan_amount": 278149,
        "loan_sub_type": "SUPPLY_CHAIN_FINANCING",
        "loan_tenure_in_months": 12,
        "loan_type": "BUSINESS",
        "purpose": "Working Capital"
    },
    "personal_details": {
        "dob": "2023-02-08",
        "email": "[email protected]",
        "first_name": "Saurav",
        "gender": "MALE",
        "last_name": "Bhardwaj",
        "mobile_number": "9484848444",
        "pan_card": "AKAPJ5349R",
        "personal_address": {
            "address_line1": "C3, Pathikrit Bhavam",
            "address_line2": "Bandra Juhu",
            "city": "Guntur",
            "pincode": "560024",
            "state": "Andhra Pradesh"
        }
    },
    "remarks": "Loan is Approved for lead_id : cf_lead_1677496119001",
    "status": "LOAN_APPROVED"
}

Payload Parameter Description

The table below lists the different parameters that might be in the webhook events and its descriptions:

ParameterDescription
lead_idIt represents the unique ID created to identity the lead.
customer_idIt represents the unique ID created by Cashfree Payments when a lead is created.
line_idIt represents 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.
first_nameIt represents the first name of the customer.
last_nameIt represents the last name of the customer.
emailIt represents the email address of the customer.
dobIt represents the date of birth of the customer.
genderIt represents the gender of the customer.
mobile_numberIt represents the mobile number of the customer.
pan_cardIt represents the PAN information of the customer.
aadhaar_numberIt represents the aadhaar number of the customer.
gstinIt represents the GST registration number of the business the customer runs.
company_panIt represents the PAN information of the business the customer runs.
udyog_aadhaarIt represents the udyog aadhaar number of the business the customer runs.
business_nameIt represents the name of the business the customer runs.
business_typeIt represents the type of business the customer runs.
business_vintage_in_monthsIt represents the number of months since the business started.
business_revenueIt represents the revenue of the business the customer runs.
loan_amountIt represents the expected loan amount.
loan_typeIt represents the requested type of loan.
loan_sub_typeIt represents the requested subtype of the loan.
loan_tenure_in_monthsIt represents the amount of time to repay the requested money.
purposeIt represents the purpose of the line of credit request.
statusIt represents the status of the event.
addressIt represents the business operating address.
cityIt represents the current city where the business operates.
stateIt represents the state of the current city where the business operates.
pincodeIt represents the PIN code of the business operating address.
remarksIt represents the reason or message describing the status of the event.
addedOnIt represents the entry creation date.