Webhook Events

We use webhooks to notify you about important events on your payments. 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 Webhook Events

The table below shows the various webhook events triggered while making a payout.

Webhook Events	Description
payment.created	Triggered when a UPI collect request is successfully created.
payments.updated	Triggered when the UPI collect request undergoes a status change.

Sample Payloads

Payments Created

Triggered when a UPI collect request is successfully created.

{
  "id": "evl_llAStNiyWShkO2EaGM1k8iL9C",
  "object": "event",
  "name": "payments.created",
  "is_sandbox": false,
  "data": {
    "object": {
      "id": "tx_lNbYh1QWXRw8Gk5uNf0smicvZ",
      "object": "payment",
      "type": "collect",
      "account_id": "va_MXzw7ioW4NSgnuYDMbePHK3Cy",
      "amount": 1,
      "currency": "inr",
      "transacted_at": null,
      "bank_reference_number": "220601503307",
      "status": "pending",
      "remitter_bank_account_number": null,
      "remitter_bank_ifsc_code": null,
      "remitter_full_name": null,
      "remitter_note": null,
      "remitter_vpa_handle": "9876543210@ibl",
      "paid_mode": "upi",
      "paid_to": "anilreddy@yesbank",
      "transaction_reference_id": null,
      "remark": "Lego Death Star",
      "merchant_reference_id": "1000247",
      "expiry_in_minutes": 3,
      "mandate_id": null,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "is_sandbox": false,
      "link": null,
      "created_at": 1658737934,
      "is_settled": false,
      "settled_at": null
    }
  }
}

Payments Updated

Triggered when the UPI collect request undergoes a status change.

{
  "id": "evl_tbs3NybYGbbjP5MMzptoFyU3W",
  "object": "event",
  "name": "payments.updated",
  "is_sandbox": false,
  "data": {
    "object": {
      "id": "tx_LDOr1fte7Npd5xBTS6BMGuRd6",
      "object": "payment",
      "type": "collect",
      "account_id": "va_MXzw7ioW4NSgnuYDMbePHK3Cy",
      "amount": 1,
      "currency": "inr",
      "transacted_at": 1658741496,
      "bank_reference_number": "220601609446",
      "status": "success",
      "remitter_bank_account_number": "XXXXXX5640",
      "remitter_bank_ifsc_code": "HDFC0000123",
      "remitter_full_name": "Sunil Reddy",
      "remitter_note": "Lego Death Star",
      "remitter_vpa_handle": "9876543210@ibl",
      "paid_mode": "upi",
      "paid_to": "anilreddy@yesbank",
      "transaction_reference_id": "418ab972d9bc4b44834c3d5a2eb95315",
      "remark": "Lego Death Star",
      "merchant_reference_id": "1000248",
      "expiry_in_minutes": 3,
      "mandate_id": null,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "is_sandbox": false,
      "link": null,
      "created_at": 1658741486,
      "is_settled": true,
      "settled_at": 1658742486
    }
  }
}