Webhook
After the completion of every payment/refund call, Juspay will provide direct notification to your server regarding events, like: Loan Application Initiated, Offer Selected, KYC Completed, Loan Active etc.. These direct notifications are called Webhooks. Configuring Hypercredit webhooks is an optional step.
Importance of Webhooks:
There are two ways to know the transaction status, first by calling HyperCredit Order Status API and second by consuming the webhooks for respective events. We always recommend using both and not rely on any one of them.
Why would we say that?
It's possible that the status of an order was updated, but you may not have polled our HyperCredit Order Status API. This could result in a delay in updating your customers about their order status. To address this issue and ensure timely updates to your customers, we highly recommend utilizing Webhooks in addition to the HyperCredit Order Status API.
Payment redirection using customers' browsers is not reliable all the time. There would be instances where customers' devices would be on low-quality connections and thereby the final redirection might not succeed. In such cases, a webhook call can help you complete the order for the customer.
Handling Webhook:
When consuming webhooks, it's essential to provide a 200 Status Response. Juspay considers a webhook as "not notified" if it receives a non-200 response and will re-send the webhook until a 200 response is received.
Configuring Webhooks:
HyperCredit Webhooks cannot be enabled directly by the merchant. Instead, they are configured by the HyperCredit Merchant Success Team upon request from the merchant.
To enable webhooks, please share the following details:
Path - This is the path of the server where you wish to receive the webhooks
Domain - This is the domain of the server where you wish to receive the webhook
Upon receiving these details, the Juspay HyperCredit team will configure the webhook URL on the backend, enabling its use.
To know in detail about all the events HyperCredit provides, kindly check out the Webhook Events and Sample Payloads.
WEBHOOK SAMPLE PAYLOAD:
Webhook Events
The merchant will receive webhook notifications for the below mentioned events:
|
Event
|
Description
|
|---|---|
LOAN_PROCESS_INITIATED
| User has started filling in details for Loan.
|
BUREAU_FETCHED
| Applicant’s Bureau information fetched successfully
|
ELIGIBILITY_CRITERIA_QUALIFIED
| Applicant passed Eligibility Criteria of 1 or more Lenders
|
ELIGIBILITY_CRITERIA_REJECTED
| Applicant failed Eligibility Criteria of all the lenders
|
LENDER_SELECTED
| Applicant has initiated Loan with Lender/s
|
LOAN_OFFERED
| One or more Loan Schemes offered by Lender
|
IN_PROGRESS_BY_LENDER
| Applicant has been redirected to Lender’s Website
|
OFFER_SELECTED
| Applicant has opted for one Loan Offer
|
USER_ACTION_REQUIRED
| Applicant needs to perform additional Steps
|
KYC_COMPLETED
| Applicant has completed KYC
|
KYC_REJECTED
| Applicant KYC didn’t meet lender’s requirement
|
REPAYMENT_COMPLETED
| Applicant completed Repayment
|
AGREEMENT_SIGNED
| Applicant completed Agreement
|
DOWNPAYMENT_COMPLETED
| Applicant completed Downpayment
|
LOAN_GRANTED
| Loan was granted by the Lender
|
LOAN_ACTIVE
| Loan has been Disbursed by the lender
|
LENDER_LOAN_REJECTED
| Lender has Rejected user’s Loan Application
|
LOAN_APPLICATION_FAILED
| Loan Application failed due to some error
|
USER_ABORTED_LOAN_APPLICATION
| User has aborted the Loan Application
|
UTR_RECEIVED
| UTR Information Received
|