API ReferenceIntegrationsKnowledge Base

Payments - Sample Payload

Orders and payments go hand-in-hand. Once a payment is captured, the order is marked paid. This is reflected in the order.paid and payment.captured Webhook events as well. These events are triggered when the payment associated with the order is captured.

Comparison - payment.captured Vs. order.paid🔗

payment.captured Webhook Event

order.paid Webhook Event

You do not have to integrate with the Orders API to trigger this event.

You must integrate with the Orders API and pass the order_id parameter to Checkout to trigger this event.

This payload contains the payment entity. Hence, only payment details are available.

This payload contains the payment and order entities. Thus, order and payment information are available in the same payload.

Payments🔗

The table below lists the Webhook events available for payments.

Webhook Event

Description

payment.authorized

Triggered when a payment is authorised.

payment.captured

Triggered when a payment is successfully captured.

payment.failed

Triggered when a payment fails.

Handy Tips

  • The payload for a Webhook is a snapshot of the entity when the event occurred. For example, when a customer makes a payment, its status changes to authorized. It can then immediately move to the captured state.
  • The payment can be in the captured state when the payment.authorized Webhook is fired. However, the payload for the payment.authorized event contains details of the events when the payment was authorised, not when it was captured.

Payment Authorized🔗

Payment Captured🔗

Payment Failed🔗

Watch Out!
Do not hardcode the vpa parameter in the integration. If a UPI Intent payment fails, the vpa parameter may not get displayed at times.

Handy Tips
If you have changed your webhook secret, remember to use the old secret for webhook signature validation while retrying older requests. Using the new secret will lead to signature mismatch.

Do Not Parse or Cast the Webhook Request Body
While generating a signature at your end, ensure that the webhook body is passed as an argument in the raw webhook request body. Do not parse or cast the webhook request body.

Payments Downtime🔗

The table below lists the webhook events available for payments downtime.

Webhook Event

Description

payment.downtime.started

Triggered at the beginning of the downtime.

payment.downtime.resolved

Triggered when a downtime is resolved.

payment.downtime.updated

Triggered when a downtime is updated.

Payment Downtime Started🔗

Payment Downtime Resolved🔗

Payment Downtime Updated🔗

×