Payment Payloads
Sample payload for Payments.
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.
The table below lists the Webhook events available for payments.
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 thecapturedstate. - The payment can be in the
capturedstate when thepayment.authorizedWebhook is fired. However, the payload for thepayment.authorizedevent contains details of the events when the payment was authorised, not when it was captured. - In case of network tokenised cards, the last 4 digits will be of the tokenised card and not the actual card.
- The field
flowis present only in the case of Turbo UPI Payments.
Watch Out!
You may occasionally observe a payment.failed webhook followed by a payment.captured webhook for the same transaction. While late authorisation is a known reason for this, user-initiated retries, particularly with UPI transactions, also cause this sequence.
Here is a common scenario:
A customer attempts a UPI payment via their Third-Party Application Provider (TPAP) such as PhonePe or Google Pay. The initial attempt fails, perhaps due to an incorrect PIN or insufficient balance.
Most UPI TPAPs offer an immediate option to retry the payment directly within their app. When a customer retries, here is how our system responds:
- We trigger and send a
payment.failedwebhook to your configured endpoint, indicating the initial payment failure. - If the customer retries the payment and successfully completes it (for example, by entering the correct PIN), the transaction concludes.
- Subsequently, we send a
payment.capturedwebhook, confirming the successful capture of funds for that same transaction.
This sequence is expected behaviour. It allows customers to correct errors and complete their transactions without having to start a new payment process.
Watch Out!
- Do not hardcode the
vpaparameter in the integration. If a UPI Intent payment fails, thevpaparameter may not get displayed at times. - The webhook sequence is not fixed in the JSON payload for payment events.
payment.failedis not triggered if the payment fails during authorisation (while making the first payment).
Watch Out!
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 a 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.
The table below lists the webhook events available for payments downtime.
Was this page helpful?