Webhooks
After the completion of every order, Juspay will provide direct notification to your server regarding the event. These are called Webhooks. You must configure a valid HTTPS endpoint that is reachable from our servers to consume these notifications. Our servers will push data using HTTPS POST call to your endpoint.
Webhooks can be configured for order level, fulfillment level, and transaction level events from Juspay dashboard as per your requirement. Juspay can also provide webhooks for validation status of beneficiary created.
Events
|
Event Name (value)
|
Event Type (label)
|
Description
|
|---|---|---|
FULFILLMENTS_SCHEDULED
| ORDER
| Fullfillment is added to the process tracker
|
FULFILLED_PARTIALLY
| ORDER
| One of the fulfillments is completed
|
FULFILLMENTS_FAILURE
| ORDER
| All fulfillment attempts have failed
|
FULFILLMENTS_SUCCESSFUL
| ORDER
| Fulfillment completed successfully
|
FULFILLMENTS_MANUAL_REVIEW
| ORDER
| One of the fulfillments is in manual review
|
FULFILLMENTS_CANCELLED
| ORDER
| Fulfillment cancelled by the merchant
|
INITIATED
| FULFILLMENT_ORDER
| Fulfillment created at Juspay
|
FAILURE
| FULFILLMENT_ORDER
| Fulfillment failed
|
SUCCESS
| FULFILLMENT_ORDER
| Fulfillment completed successfully
|
DISCARDED
| FULFILLMENT_ORDER
| Fulfillment discarded by merchant
|
MANUAL_REVIEW
| FULFILLMENT_ORDER
| Fulfillment in manual review state.
|
CANCELLED
| FULFILLMENT_ORDER
| Fulfillment cancelled by the merchant
|
INITIATED
| FULFILLMENT_TXN
| Transaction initiated to the payment gateway
|
FAILURE
| FULFILLMENT_TXN
| Transaction failed
|
SUCCESS
| FULFILLMENT_TXN
| Transaction processed successfully
|
REVERSED
| FULFILLMENT_TXN
| Transaction marked as failure from success by the payment gateway
|
CONFLICTED
| FULFILLMENT_TXN
| Transaction marked as success from failure by the payment gateway
|
MANUAL_REVIEW
| FULFILLMENT_TXN
| Transaction stuck in pending state
|
VALID
| VALIDATION_V2
| Beneficiary added is valid
|
INVALID
| VALIDATION_V2
| Beneficiary added is invalid
|
ERROR
| VALIDATION_V2
| Beneficiary could not be validated
|
VALID
| VALIDATION
| Beneficiary added is valid
|
INVALID
| VALIDATION
| Beneficiary added is invalid
|
ERROR
| VALIDATION
| Beneficiary could not be validated
|
GATEWAY_SWITCHED
| SR_BASED_ROUTING
| Gateway switched by Juspay Decider
|
READY_FOR_FULFILLMENT
| ORDER
| Request received by Juspay
|
Webhook Authentication
We support Basic HTTP Authentication for your Webhook URL. Using Username and password fields to authenticate the webhook call is mandatory. Please ensure that special characters like @ are not used in username. You can also add customer header as per your requirement
Basic webhook structure
{
id : webhook_id
, category : "INFO"
, label : "VALIDATION_V2"
, value : validation status
, info : validation response for a beneId
}
Handling Failures
If your server is not reachable and we receive a non-200 response when we are attempting webhook notification, we would mark the webhook notified section in our dashboard as False. Hence, consume webhooks on with 200 response code.
Although our webhooks are reliable, it is always suggested that you use our Order Status API to poll our systems, in case you do not receive the webhooks in time.
This will handle the cases where the webhooks could not be notified to your system. The threshold beyond which you start polling our system can be decided basis your business use case.