Webhook Events

Check the webhook payloads for events relevant to Magento Plugin for Razorpay Subscriptions.


Webhooks (Web Callback, HTTP Push API or Reverse API) are one way that a web application can send information to another application in real-time when a specific event happens.

Example
Suppose you have subscribed to the order.paid webhook event, you will receive a notification every time a user pays you for an order.

APIs send you the data when you request it. For Webhooks, you do not need to make a request. You receive the data when it is available.

Example

If you need to know whether a Payment Link is paid or not, using APIs, you need to keep polling every few seconds until someone pays. However, if you are using Webhooks, you can configure a webhook event payment_link.paid to receive notifications when a customer makes the payment using the link.

You can use Razorpay Webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL.

  • You can set up Webhooks from your Razorpay Dashboard and configure separate URLs for Live mode and Test mode. Know more about setting up and .
  • A Test mode webhook receives events for your test transactions. Know more about .
  • In webhook URLs, only port numbers 80 and 443 are currently allowed.

Currently, webhooks are available for the following events:

Webhook EventDescription
payment.authorizedSent when the authorization payment has been made for the Subscription. A nominal amount is charged to validate the card details and is then automatically refunded.
order.paidTriggered when an order is successfully paid.
subscription.pausedSent when a Subscription is paused and moved to the paused state.
subscription.cancelledSent when a subscription is cancelled and moved to the cancelled state.
payment.failedSent when the payment attempt for a Subscription fails.
subscription.cancelledSent when a Subscription is cancelled and moved to the cancelled state.

Handy Tips

The payload for all these events would contain the Subscription entity. They would also contain a payment entity if a payment attempt was made before the event was triggered.

{
"entity":"event",
"account_id":"acc_DDiURNtiQ5kFsb",
"event":"payment.authorized",
"contains":[
"payment"
],
"payload":{
"payment":{
"entity":{
"id":"pay_DGoUVWeFLKKacL",
"entity":"payment",
"amount":6000,
"currency":"INR",
"status":"authorized",
"order_id":"order_DGoUOaUvWLGnEO",
"invoice_id":"inv_DGoUOZNF6uGBcA",
"international":false,
"method":"upi",
"amount_refunded":0,
"refund_status":null,
"captured":false,
"description":"Order 251",
"card_id":null,
"bank":null,
"wallet":null,
"vpa":"123@upi",
"email":"gaurav.kumar@example.com",
"contact":"+919999999998",
"customer_id":"cust_DG44HEGMbfRm1N",
"token_id":"token_DG4GL5OAv8tSYE",
"notes":{
"magento_order_id":"",
"merchant_quote_id":"36"
},
"fee":null,
"tax":null,
"error_code":null,
"error_description":null,
"error_source":null,
"error_step":null,
"error_reason":null,
"acquirer_data":{
"rrn":"001000100002",
"upi_transaction_id":"npci_txn_id_for_IilTQTf37sXXNX"
},
"created_at":1641976110
}
}
},
"created_at":1641976110
}

{
"entity":"event",
"account_id":"acc_FzO2PyLE5ZYkW8",
"event":"order.paid",
"contains":[
"payment",
"order"
],
"payload":{
"payment":{
"entity":{
"id":"pay_IilTQTf37sXXNX",
"entity":"payment",
"amount":6000,
"currency":"INR",
"base_amount":6000,
"status":"captured",
"order_id":"order_IilT1yadIMdg9b",
"invoice_id":"inv_IilT1w4sLgP3s2",
"international":false,
"method":"upi",
"amount_refunded":0,
"amount_transferred":0,
"refund_status":null,
"captured":true,
"description":null,
"card_id":null,
"bank":null,
"wallet":null,
"vpa":"123@upi",
"email":"roni_cost@example.com",
"contact":"+1234567890",
"customer_id":"cust_IilSzuBJCNvrsu",
"token_id":"token_IilTQiLc4NU0je",
"notes":{
"merchant_order_id":"",
"merchant_quote_id":"36"
},
"fee":142,
"tax":22,
"error_code":null,
"error_description":null,
"error_source":null,
"error_step":null,
"error_reason":null,
"acquirer_data":{
"rrn":"001000100002",
"upi_transaction_id":"npci_txn_id_for_IilTQTf37sXXNX"
},
"created_at":1641976110
}
},
"order":{
"entity":{
"id":"order_IilT1yadIMdg9b",
"entity":"order",
"amount":6000,
"amount_paid":6000,
"amount_due":0,
"currency":"INR",
"receipt":null,
"offer_id":null,
"status":"paid",
"attempts":1,
"notes":[
],
"created_at":1641976087
}
}
},
"created_at":1641976113
}

{
"entity":"event",
"account_id":"acc_FzO2PyLE5ZYkW8",
"event":"subscription.charged",
"contains":[
"subscription",
"payment"
],
"payload":{
"subscription":{
"entity":{
"id":"sub_IilT1Ob70FQPp3",
"entity":"subscription",
"plan_id":"plan_IilSFBnjkbmBuP",
"customer_id":"cust_IilSzuBJCNvrsu",
"status":"active",
"current_start":1641976110,
"current_end":1644949800,
"ended_at":null,
"quantity":1,
"notes":{
"source":"magento-subscription",
"magento_quote_id":"36"
},
"charge_at":1644949800,
"start_at":1641976110,
"end_at":1657045800,
"auth_attempts":0,
"total_count":6,
"paid_count":1,
"customer_notify":false,
"created_at":1641976086,
"expire_by":null,
"short_url":null,
"has_scheduled_changes":false,
"change_scheduled_at":null,
"source":"magento-subscription",
"payment_method":"upi",
"offer_id":null,
"remaining_count":5
}
},
"payment":{
"entity":{
"id":"pay_IilTQTf37sXXNX",
"entity":"payment",
"amount":6000,
"currency":"INR",
"status":"captured",
"order_id":"order_IilT1yadIMdg9b",
"invoice_id":"inv_IilT1w4sLgP3s2",
"international":false,
"method":"upi",
"amount_refunded":0,
"amount_transferred":0,
"refund_status":null,
"captured":"1",
"description":null,
"card_id":null,
"bank":null,
"wallet":null,
"vpa":"123@upi",
"email":"roni_cost@example.com",
"contact":"+1234567890",
"customer_id":"cust_IilSzuBJCNvrsu",
"token_id":"token_IilTQiLc4NU0je",
"notes":{
"merchant_order_id":"",
"merchant_quote_id":"36"
},
"fee":142,
"tax":22,
"error_code":null,
"error_description":null,
"acquirer_data":{
"rrn":"001000100002",
"upi_transaction_id":"npci_txn_id_for_IilTQTf37sXXNX"
},
"created_at":1641976110
}
}
},
"created_at":1641976178
}

{
"entity":"event",
"account_id":"acc_FzO2PyLE5ZYkW8",
"event":"subscription.paused",
"contains":[
"subscription"
],
"payload":{
"subscription":{
"entity":{
"id":"sub_IilT1Ob70FQPp3",
"entity":"subscription",
"plan_id":"plan_IilSFBnjkbmBuP",
"customer_id":"cust_IilSzuBJCNvrsu",
"status":"paused",
"type":3,
"current_start":1641976110,
"current_end":1644949800,
"ended_at":null,
"quantity":1,
"notes":{
"source":"magento-subscription",
"magento_quote_id":"36"
},
"charge_at":null,
"start_at":1641976110,
"end_at":1657045800,
"auth_attempts":0,
"total_count":6,
"paid_count":1,
"customer_notify":false,
"created_at":1641976086,
"expire_by":null,
"short_url":null,
"has_scheduled_changes":false,
"change_scheduled_at":null,
"source":"magento-subscription",
"payment_method":"upi",
"offer_id":null,
"remaining_count":5,
"pause_initiated_by":"self",
"cancel_initiated_by":null
}
}
},
"created_at":1641976696
}

{
"entity": "event",
"account_id": "acc_FzO2PyLE5ZYkW8",
"event": "subscription.cancelled",
"contains": [
"subscription"
],
"payload": {
"subscription": {
"entity": {
"id": "sub_IilT1Ob70FQPp3",
"entity": "subscription",
"plan_id": "plan_IilSFBnjkbmBuP",
"customer_id": "cust_IilSzuBJCNvrsu",
"status": "cancelled",
"type": 3,
"current_start": 1641976110,
"current_end": 1644949800,
"ended_at": 1641976760,
"quantity": 1,
"notes": {
"source": "magento-subscription",
"magento_quote_id": "36"
},
"charge_at": null,
"start_at": 1641976110,
"end_at": 1657045800,
"auth_attempts": 0,
"total_count": 6,
"paid_count": 1,
"customer_notify": false,
"created_at": 1641976086,
"expire_by": null,
"short_url": null,
"has_scheduled_changes": false,
"change_scheduled_at": null,
"source": "magento-subscription",
"payment_method": "upi",
"offer_id": null,
"remaining_count": 5
}
}
},
"created_at": 1641976762
}

Was this page helpful?