Events

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.

Notification structure

A typical webhook notification will contain the following set of fields,

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.

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.

The following sample is for the event PAYMENT involving the payment type Credit Card,

WEBHOOK
{
  "event": {
    "checksum": "3ddf5548991311e9eb137fb9f0411d2290b8dae4168763385e1738a63c8f7e10",
    "tid": ###NOVALNET_TID###,
    "type": "PAYMENT"
  },
  "result": {
    "status": "SUCCESS",
    "status_code": 100,
    "status_text": "Successful"
  },
  "transaction": {
    "amount": ###TRANSACTION_AMOUNT###,
    "currency": "###TRANSACTION_CURRENCY###",
    "hook_url": "###YOUR_HOOK_URL###",
    "order_no": "###TRANSACTION_ORDER_NUMBER###",
    "invoice_no":"###INVOICE_NO###",
    "payment_data": {
      "card_brand": "VISA",
      "card_expiry_month": 2,
      "card_expiry_year": 2022,
      "card_holder": "Max Mustermann",
      "card_number": "XXXXXXXXXXXX0000",
      "last_four": "0000",
    },
    "payment_type": "###PAYMENT_TYPE###",
    "status": "CONFIRMED",
    "status_code": 100,
    "test_mode": ###TEST_MODE###,
    "tid": ###NOVALNET_TID###
  },
  "customer": {
    "billing": {
      "city": "Musterhausen",
      "company": "ABC Gmbh",
      "country_code": "DE",
      "house_no": "2",
      "street": "Musterstr",
      "zip": "12345"
    },
    "customer_ip": "###CUSTOMER_IP###",
    "customer_no": "###CUSTOMER_NUMBER###",
    "email": "test@test.de",
    "first_name": "Max",
    "gender": "u",
    "last_name": "Mustermann",
    "tel": "+49 089 123456"
  },
  "custom" : {
    "input1": "###INPUT1###",
    "inputval1": "###INPUTVAL1###",
    "###INPUT1###": "###INPUTVAL1###"
   },
  "merchant": {
    "project": 6120,
    "project_name": "Developer Portal",
    "project_url": "https://developer.novalnet.de",
    "vendor": 4
  }
}

To know more about the entire list of objects and parameters that are received in the notification request, refer this >>link<<

Types of events

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.

Basic events

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.

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Direct Debit ACH DIRECT_DEBIT_ACH
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Instalment by invoice INSTALMENT_INVOICE
Instalment by SEPA direct debit INSTALMENT_DIRECT_DEBIT_SEPA
Online bank transfer ONLINE_BANK_TRANSFER
Ideal IDEAL
Trustly TRUSTLY
eps EPS
Przelewy24 PRZELEWY24
Multibanco MULTIBANCO
PayPal PAYPAL
PostFinance POSTFINANCE
PostFinance Card POSTFINANCE_CARD
Bancontact BANCONTACT
Alipay ALIPAY
WeChat Pay WECHATPAY
Apple Pay APPLEPAY
Google Pay GOOGLEPAY
SEPA Credit SEPA_CREDIT
MB Way MBWAY
Funds Transfer FUNDS_TRANSFER
BLIK BLIK
Payconiq PAYCONIQ
KakaoPay KAKAOPAY
Naver Pay NAVERPAY
EPC-QR-Pay EPC_QRPAY
TWINT TWINT

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD_REPRESENTMENT, CREDIT_ENTRY_CREDITCARD, DEBT_COLLECTION_CREDITCARD
Direct Debit SEPA CREDIT_ENTRY_SEPA, DEBT_COLLECTION_SEPA, BANK_TRANSFER_BY_END_CUSTOMER
Invoice, Prepayment INVOICE_CREDIT, DEBT_COLLECTION_DE, BANK_TRANSFER_BY_END_CUSTOMER
Instalment by Invoice BANK_TRANSFER_BY_END_CUSTOMER
Online bank transfer, Trustly ONLINE_TRANSFER_CREDIT, DEBT_COLLECTION_DE
Eps ONLINE_TRANSFER_CREDIT
Ideal ONLINE_TRANSFER_CREDIT, DEBT_COLLECTION_DE, BANK_TRANSFER_BY_END_CUSTOMER
Multibanco MULTIBANCO_CREDIT
PayPal CREDIT_ENTRY_DE
Apple Pay APPLEPAY_REPRESENTMENT
Google Pay GOOGLEPAY_REPRESENTMENT
SEPA Credit, Direct Debit SEPA, Invoice, Prepayment, Invoice with payment guarantee, Direct Debit SEPA with payment guarantee, Instalment by Invoice, Instalment by Direct Debit SEPA, Online bank transfer, iDEAL
Wero, eps, Bancontact, Payconiq REFUND_REVERSAL
Alipay, WeChat Pay, MB Way, Payconiq and TWINT WALLET_CREDIT

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Instalment by invoice INSTALMENT_INVOICE
Instalment by Direct Debit SEPA INSTALMENT_DIRECT_DEBIT_SEPA
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY
SEPA Credit SEPA_CREDIT

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Instalment by invoice INSTALMENT_INVOICE
Instalment by Direct Debit SEPA INSTALMENT_DIRECT_DEBIT_SEPA
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY
SEPA Credit SEPA_CREDIT
Przelewy24 PRZELEWY24

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Instalment by invoice INSTALMENT_INVOICE
Instalment by SEPA direct debit INSTALMENT_DIRECT_DEBIT_SEPA
Online bank transfer ONLINE_BANK_TRANSFER
Ideal IDEAL
Trustly TRUSTLY
eps EPS
Przelewy24 PRZELEWY24
Multibanco MULTIBANCO
PayPal PAYPAL
PostFinance POSTFINANCE
PostFinance Card POSTFINANCE_CARD
Bancontact BANCONTACT
Alipay ALIPAY
WeChat Pay WECHATPAY
Apple Pay APPLEPAY
Google Pay GOOGLEPAY
MB Way MBWAY
Payconiq PAYCONIQ
KakaoPay KAKAOPAY
Naver Pay NAVERPAY
TWINT TWINT

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD_BOOKBACK
Direct Debit SEPA, Invoice, Prepayment, Invoice with payment guarantee, Direct Debit SEPA with payment guarantee, Instalment by Invoice, Instalment by Direct Debit SEPA, Online bank transfer, iDEAL
Wero, eps, Bancontact, Payconiq REFUND_BY_BANK_TRANSFER_EU
Invoice with payment guarantee GUARANTEED_INVOICE_BOOKBACK
Direct Debit SEPA with payment guarantee GUARANTEED_SEPA_BOOKBACK
Instalment by Invoice INSTALMENT_INVOICE_BOOKBACK
Instalment by Direct Debit SEPA INSTALMENT_SEPA_BOOKBACK
Trustly TRUSTLY_REFUND
Przelewy24 PRZELEWY24_REFUND
PayPal PAYPAL_BOOKBACK
PostFinance, PostFinance Card POSTFINANCE_REFUND
Alipay ALIPAY_REFUND
WeChat Pay WECHATPAY_REFUND
Apple Pay APPLEPAY_BOOKBACK
Google Pay GOOGLEPAY_BOOKBACK
Direct Debit ACH DIRECT_DEBIT_ACH_REFUND
MB Way MBWAY_REFUND
BLIK BLIK_REFUND
KakaoPay KAKAOPAY_REFUND
Naver Pay NAVERPAY_REFUND
TWINT TWINT_REFUND

Dispute events

CHARGEBACK Whenever there is a dispute for the Credit Card transaction, this event is called. For eg:- A purchase using the stolen card.

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD_CHARGEBACK
Direct Debit SEPA RETURN_DEBIT_SEPA
Online bank transfer, iDEAL
Wero, Trustly REVERSAL
PayPal PAYPAL_CHARGEBACK
Apple Pay APPLEPAY_CHARGEBACK
Google Pay GOOGLEPAY_CHARGEBACK
SEPA Credit REFUND_REVERSAL
TWINT TWINT_CHARGEBACK

Subscription events

SUBSCRIPTION_CANCEL Triggered when a subscription is stopped.
SUBSCRIPTION_UPDATE Whenever there is an action involving a subscription amount or a date change, this event will be triggered.
SUBSCRIPTION_SUSPEND Pausing a subscription will trigger this event.
SUBSCRIPTION_REACTIVATE Reactivating a suspended subscription will call this event.

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Direct Debit ACH DIRECT_DEBIT_ACH
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Direct Debit ACH DIRECT_DEBIT_ACH
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Direct Debit ACH DIRECT_DEBIT_ACH
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Direct Debit ACH DIRECT_DEBIT_ACH
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Renewal events

RENEWAL Triggered when subscription renewal bookings are created for the initial subscription transaction.

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Direct Debit ACH DIRECT_DEBIT_ACH
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Instalment event

INSTALMENT Whenever the followup instalments cycles are created for the initial Instalment transaction, this event is called.

Show supported payments

Payment Name Payment Type
Instalment by invoice INSTALMENT_INVOICE
Instalment by SEPA direct debit INSTALMENT_DIRECT_DEBIT_SEPA

Affiliate event

AFFILIATE Triggered when the subsequent bookings are created for the marketplace business model (using marketplace.tx_split).

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Invoice INVOICE
Prepayment PREPAYMENT
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Apple Pay APPLEPAY
Google Pay GOOGLEPAY
Online bank transfer ONLINE_BANK_TRANSFER
Ideal IDEAL
Trustly TRUSTLY
eps EPS
Przelewy24 PRZELEWY24
PostFinance POSTFINANCE
PostFinance Card POSTFINANCE_CARD
Bancontact BANCONTACT
Alipay ALIPAY
WeChat Pay WECHATPAY
BLIK BLIK
Payconiq PAYCONIQ
KakaoPay KAKAOPAY
Naver Pay NAVERPAY

Reminder events

PAYMENT_REMINDER_1 This event will be triggered when the first payment reminder is sent to the customer.
PAYMENT_REMINDER_2 This event will be triggered when the second payment reminder is sent to the customer.

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Invoice INVOICE
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Instalment by invoice INSTALMENT_INVOICE
Instalment by SEPA direct debit INSTALMENT_DIRECT_DEBIT_SEPA
Online bank transfer, iDEAL
Wero, Trustly REVERSAL
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Invoice INVOICE
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Instalment by invoice INSTALMENT_INVOICE
Instalment by SEPA direct debit INSTALMENT_DIRECT_DEBIT_SEPA
Online bank transfer, iDEAL
Wero, Trustly REVERSAL
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Collection events

SUBMISSION_TO_COLLECTION_AGENCY The event is triggered when the case is submitted to the collection agency.

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD
Direct Debit SEPA DIRECT_DEBIT_SEPA
Invoice INVOICE
Invoice with payment guarantee GUARANTEED_INVOICE
Direct Debit SEPA with payment guarantee GUARANTEED_DIRECT_DEBIT_SEPA
Instalment by invoice INSTALMENT_INVOICE
Instalment by SEPA direct debit INSTALMENT_DIRECT_DEBIT_SEPA
Online bank transfer, iDEAL
Wero, Trustly REVERSAL
PayPal PAYPAL
Apple Pay APPLEPAY
Google Pay GOOGLEPAY

Non-Transaction events

AFFILIATE_CREATION This event will be triggered whenever an affiliate account is created.
AFFILIATE_ACTIVATION Event is triggered when test mode to live mode activation of the affiliate account.
CALL_N_PAY This event will be triggered whenever an Call N Pay is created.
PAY_BY_LINK This event will be triggered whenever an pay by link is created.
PAYMENT_LINK_UPDATE This event will be triggered once the payment link details have been successfully updated.

Show supported payments

Payment Name Payment Type
Credit/Debit Cards CREDITCARD

Related Topics