Webhook Events

We use webhooks to notify you about important events on your KYC verification. These webhooks contain details about the event such as changes that occurred and the resources impacted by the change.

We send webhooks as HTTP POST call to a URL configured by you. The webhook payload uses the JSON format.

Learn more about our Webhooks.

Available Events

The table below lists the various webhook events triggered when verifying Aadhaar via OTP.

Webhook Events	Description
bharat_connect.payment.initiate	Triggered when the Payment Request API call is successfully made.
bharat_connect.payment.acknowledge	Triggered when the Payment Confirmation Request API call is successfully made.

Sample Payload

Payment Request

Triggered when the Payment Request API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.payment.initiate",
    "is_sandbox": true,
    "data": {
	{
    "id":"bcpa_k3pbaBewh1CmzTPTOToHywYey",
    "object":"bharat_connect.payment",
    "type":"OUTGOING",
    "invoice": {
        "id": "bcinv_k3pbaALyh1CmzTPTOToHywYey",
        "status":"PAYMENT INITIATED"
    },
    "netPaidAmount": 4,
    "netAdjustmentAmount": 0,
    "totalAmount": 4,
    "paid_mode": "",
    "initiated_at":"",
     "response":{
	    "status":"SUCCESS",
	    "message":""
    }
    "metadata":""
}

    }
}

Payment Confirmation Request

Triggered when the Payment Confirmation Request API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.payment.acknowledge",
    "is_sandbox": true,
    "data": {
	Response Object
    }
}