Webhook events, or simply events, are the triggers performed whenever an action is related to a transaction or a subscription. Each webhook notification will contain the event object that specifies which type of event (through the event.type) triggered the notification.
A typical webhook notification will contain the following set of fields,
| event |
The event object signifies an action that triggered this webhook notification. The event object contains, event.type - The type of event like initial transaction, subscription renewal, chargeback etc..,. event.tid - The TID which is relevant to this event. event.parent_tid - During the course of followup events like chargebacks, credit entry etc.., this field will contain the value of the original/initial transaction TID. event.checksum - Secure hash generated at Novalnet to perform the authentication mechanism for the webhook notification. |
| result | The result object denotes the details of the API result performed for the corresponding transaction, can be identified using the field result.status. |
| transaction |
The transaction object details about the current transaction and is segregated into, transaction.tid - The unique identifier of the transaction. transaction.amount - The transaction amount in smaller currency unit (For eg:- Cents). transaction.currency - The currency in which the transaction is placed. transaction.payment_type - The payment type involved in the transaction. transaction.order_no - Order number linked to the transaction. transaction.payment_data - If the payment details are involved, their masked pattern will be returned here. transaction.test_mode - Specifies whether the event that triggered the notification happened on the test or live environment. |
| merchant | The details of the merchant involved in the transaction. |
The following sample is for the event PAYMENT involving the payment type Credit Card,
To know more about the entire list of objects and parameters that are received in the notification request, refer this >>link<<.
We have categorized the events based on the action performed over a transaction or a subscription and the various events that could happen per category are noted below,
- Icon denotes the follow-up events, which indicates that this event already has a base transaction and this event itself is relevant to that of the base transaction. All the follow-up events will have the event.parent_tid notification parameter containing the base transaction.
| PAYMENT |
Triggered when a new transaction is created. |
| CREDIT |
Triggered when an incoming credit comes in for the PAYMENT event. Post-pay payment methods like Invoice, Prepayment, Multibanco rely on this event type. Invoice - When the customer pays the money to Novalnet account. Prepayment - When the customer pays the money to Novalnet account. Multibanco - When the customer pays to the Multibanco ATM or in the online portal. When the customer pays for a cancelled transaction that belonging to the online transfer payment types. |
| TRANSACTION_CAPTURE |
This event is called when an onhold transaction is captured. |
| TRANSACTION_CANCEL |
When an onhold transaction gets cancelled, this event is triggered. |
| TRANSACTION_UPDATE |
Triggered whenever there is an update in the transaction amount (transaction.amount), due-date (transaction.due_date). Also triggered when there is a change in the status of a transaction transaction.status from PENDING to COMPLETED or ONHOLD |
| TRANSACTION_REFUND |
Refunding a transaction will be calling this event. Both partial and full refunds are included here. |
| INSTALMENT |
Whenever the followup instalments cycles are created for the initial Instalment transaction, this event is called. |
| AFFILIATE |
Triggered when the subsequent bookings are created for the marketplace business model (using marketplace.tx_split). |