Notification Webhooks Parameter Reference
Parameter Reference | Novalnet Docs

 Parameter Reference

On occurrence of each transaction creation or status change at Novalnet, the Novalnet system will also send all the transaction details to your webhook endpoint. The following parameters will be sent with their respective values for every payment (if successful or not) as well as for every follow up transaction, (for example: credit entry, chargeback, collection payment, etc.) and also for subscription/instalment related actions.

Notification parameters

Each payment request has been separated into so-called objects, which indicate an entity like Merchant, Customer, Transaction, etc. Use the objects which are relevant to your business model/payment type.

Each parameter is marked with attributes Mandatory, Conditional, Optional. Based on your necessity, you can use these parameters accordingly.

- Icon denotes the parameter is used on the conditional attribute basis, and hovering on this icon will give you the details about that condition.

- Icon denotes the payment methods supported or relevant to the parameter defined, and hovering on this icon will give you the details of the list of payment methods supported.

The decision making about the notification result will solely depend on the parameter status under the object result. The parameter can take up either of the values SUCCESS or FAILURE

event
Object
result
Object
transaction
Object
marker
String
Optional
DEF20140103987 A unique tag used in the APIs to group specific transactions across customers, projects for statistical overview or filtering in reporting. For example, if the transactions that were placed in the store with a particular offer need to be grouped separately, then passing this parameter with a value of "FESTIVALOFFER" can allow you to list these transactions distinctively. identifiers
Multi-Dimensional Array
The identifiers is used to tag and group transactions in a flexible way, similar to the marker parameter but with support for multiple categories. Each identifier consists of a type and a value, allowing transactions to be grouped or filtered across different dimensions (e.g., offers, customer segments, projects).
Hide child object
value
String
Conditional
FESTIVAL|B2B Defines the corresponding identifier within the selected type.

  • Ex: If type = "OFFER", then value could be "FESTIVAL".
  • Ex: If type = "CUSTOMER_TYPE", then value could be "B2B".
Note: Allowed characters include alphanumeric letters (A–Z, a–z, 0–9), underscores (_), hyphens (-), spaces, periods (.), and accented characters such as umlauts (ä, ö, ü). The maximum permitted length of this parameter is 70 characters.

bank_details
Object This object contains the bank details to which the customer has to transfer the transaction amount
Hide child object
bank_code
Integer
Conditional
74020100 Bank code bank_name
String
Conditional
Raiffeisenlandesbank O Zndl Sddeutschland Bank name bank_place
String
Conditional
Passau Place of the bank account_holder
String
Conditional
Max Mustermann Name of the bank account holder iban
String
Conditional
DE24300209002411761956 IBAN (International Bank Account Number) of the bank account holder bic
String
Optional
CMCIDEDDXXX BIC (Bank Identifier Code) of the bank account holder qr_image
String
Conditional
https://nnt.ag/epcqr/15339600072003130.png This parameter provides a hosted link to a dynamically generated QR code for applicable Pay-By-Invoice transactions. The QR code is created for all pending, authorized, and successful transactions (including subscriptions and instalment renewals) when the transaction amount is greater than zero.

For marketplace transactions, a single QR code is generated for the total order amount. If the transaction amount or order number is modified, the QR code is automatically regenerated and updated on the same link to always reflect the latest transaction details.
fraud_check
Object This objects contains the Fraud check details, for example: Buergal score
Hide child object
trader_name
String
Mandatory
Mustermann GmbH Trader name belonging to this VAT ID trader_address
String
Mandatory
Musterstr, 2, 12345, Musterhausen Trader address belonging to this VAT ID buergel_score_value
String
Optional
0 The resultant CRIF Buergel Score value from the fraud check
partner_payment_reference
Integer
Conditional
999999919 The payment reference for the Multibanco payment type. Using this reference, the customer pays in online portal or in the Multibanco ATM to complete the purchase service_supplier_id
Integer
Conditional
11854 Service supplier ID from Multibanco credit_details
Object
Hide child object
iban
String
Optional
DE2XXXXXXXXXXXXXX956 IBAN (International Bank Account Number) of the bank account holder bic
String
Optional
CMCIDEDDXXX BIC (Bank Identifier Code) of the bank account holder reason
String
Optional
Reason The reason for the credit entry/chargeback/return debit transaction reference
String
Optional
Reference Credit reference given by end customer during the bank transfer country_code
String
Optional
DE Customer's billing country. The two-character country ISO code as defined in ISO-3166-1 alpha-2 address
String
Optional
Musterstr 1, 12345 Musterhausen Address of the account holder given in bank transfer
status_code
Integer
Mandatory
100 Status code for the transaction order_date
String
Conditional
2021-06-10 Original purchase date, for which the cashback or transaction is being processed

Note: The format to be specified is "YYYY-MM-DD". order_amount
Integer
Conditional
2000 Original purchase amount, for which the cashback or transaction is being processed order_reference
String
Conditional
XXXYYYZZZ Original purchase reference or order number, for which the cashback or transaction is being processed authorization
Object
Hide child object
auto_action
String
Conditional
CAPTURE|VOID It contains the action (CAPTURE/VOID) going to be carried out on the expiry of the authorization.Note: Merchant can customize these action on Novalnet Admin Portal.
mandate_ref
String
Optional
NN-12345678901234567 Unique mandate reference of the written SEPA mandate, this reference will be displayed in the end-customer's bank statement. If not provided, by default TID will be considered mandate_date
String
Optional
2026-08-20 Start date at which the end-customer allowed Novalnet or the merchant to book from his/her account. The date of signature of SEPA mandate. If not provided, by default the transaction date will be considered.

Note: The format to be specified is "YYYY-MM-DD".

invoice_no
String
Optional
852963 Unique identifier invoice number from the shop transfer_type
String
Optional
DEBIT Specify the transfer type CREDIT or DEBIT.

  • CREDIT - Debited from Marketplace and Credited to Affiliate or subvendor
  • DEBIT - Debited from Affiliate or subvendor and credited to Marketplace
By default, if this parameter is not passed, the transfer type will be DEBIT qr_image
String
Conditional
https://nnt.ag/qr/ux631hb9.png The QR image of the shortened URL partner_payment_url
String
Mandatory
https://pagar.wepayout.co/?hash=XXXXXX The payment reference for the Boleto payment type. It contains the bank slip URL. update_type
String
Optional
STATUS|AMOUNT|DUE_DATE|AMOUNT_DUE_DATE|PAYMENT_DATA The update_type provided for change of the status, amount/ due date and payment data of the transaction. link_expiry
String
Conditional
2020-04-30 23:59:59 The expiry period of the shortened URL. The format to be specified is "YYYY-MM-DD HH:MM:SS".

Note: By default, the shortened URL will be valid for 21 days.

refund
Object
Hide child object
payment_type
String
Conditional
CREDITCARD_BOOKBACK Transaction's Payment type (defined in Novalnet). Refer this section for the payment type details. amount
Integer
Mandatory
522 The total amount to be charged from the customer includes the line items, tax, shipping and additional costs (in minor units), e.g., Euro in Eurocents (5,22 € = 522).

Note: For zero amount booking feature, set amount to 0 (zero).

currency
String
Mandatory
EUR The currency in which the transaction is being processed. The three-character currency code as defined in ISO-4217.
refunded_amount
Integer
Conditional
100 Total refunded amount debit_reason_1..5
String
Optional
www.test.com The debit reason defines the text on the customer's proof of payment (e.g., bank statement records and similar).Note: Each debit reason can have a maximum of 27 characters, with an overall length of 140 characters for all five debit reasons. The debit reason is case-sensitive, allowing characters from a to z, A to Z, and 0 to 9. Only space and hyphens are allowed, while other special characters and symbols are taken as spaces. credit_reason_1..5
String
Optional
www.test.com The credit reason defines the text on the customer's proof of payment (e.g., bank statement records and similar).Note: Each credit reason can have a maximum of 27 characters, with an overall length of 140 characters for all five credit reason. The credit reason is case-sensitive, allowing characters from a to z, A to Z, and 0 to 9. Only space and hyphens are allowed, while other special characters and symbols are taken as spaces.
customer
Object
customer_ip
String
Mandatory
127.0.0.1 Customer's IP address customer_no
String
Optional
12345 Customer's unique identifier from the shop birth_date
String
Conditional
1992-06-10 Customer's date of birth. The format to be specified is "YYYY-MM-DD"

Note: Mandatory only for B2C for processing guaranteed and installment payments such as GUARANTEED_DIRECT_DEBIT_SEPA, GUARANTEED_INVOICE, INSTALMENT_DIRECT_DEBIT_SEPA, INSTALMENT_INVOICE

tel
String
Optional
+49 089 123456 Customer's telephone number mobile
String
Optional
+491747781423 Customer's mobile number fax
String
Optional
+49 89 654321 Customer's fax number shipping
Object This object contains the customer's shipping information
Hide child object
first_name
String
Optional
Max Customer's shipping firstname last_name
String
Optional
Mustermann Customer's shipping lastname email
String
Optional
test@novanet.de Customer's shipping email address company
String
Optional
ABC GmbH Organization name of the shipping address house_no
String
Optional
2 Customer's shipping house extension street
String
Optional
Musterstr Customer's shipping street name city
String
Optional
Musterhausen Customer's shipping city zip
String
Optional
12345 Customer's postal code country_code
String
Optional
DE Customer's shipping country. The two-character country ISO code as defined in ISO-3166-1 alpha-2 tel
String
Optional
+49 089 123456 Customer's shipping telephone number mobile
String
Optional
+491747781423 Customer's shipping mobile number state
String
Optional
Berlin The customer's shipping state identifies a specific region within a country. Novalnet currently supports this parameter in three formats:
  • ISO 3166-2 State Codes: Provide the state using the state code according to the ISO 3166-2 standard for seamless transmission during payment processing. For example, state codes (such as "BE" for Berlin) are typically 2 characters long.
  • Country Code Format: The state code in country code format for Germany is "DE-" followed by the 2-letter state code (e.g., "DE-BE" for Berlin, "DE-HH" for Hamburg).
  • Full State Names: Full state names can be provided using string characters with a maximum length of up to 50 characters (e.g., "Berlin", "Hamburg").
Note: Allowed characters are alphanumeric, numbers, space, hyphen, apostrophe, period and other accented characters such as umlauts, Latin characters. district
String
Optional
Pankow The customer's district from the shipping information, which identifies a specific administrative region within a state or province.

Note: Allowed characters are alphanumeric, numbers, space, hyphen, apostrophe, period and other accented characters such as umlauts, Latin characters.

vat_id
String
Optional
DE123456 Organization's VAT ID tax_id
String
Conditional
123/123/123 The parameter represents the unique tax identification number assigned to a customer or company. This is essential for compliance with tax regulations and enables accurate identification of businesses in B2B transactions.Note: Allowed characters are alphanumeric, numbers, space, hyphen and period. reg_no
String
Optional
HRB1234 Organization's registration number session
String
Optional
fedgrgst5653653hdgfsvgdsf622627e Customer's session ID from the shop no_nc
Integer
Optional
1 This parameter will be returned, If you opted for no_nc option
subscription
Object
instalment
Object
marketplace
Object
invoicing
Object
custom
Object
call_n_pay
Object
merchant
Object
affiliate
Object
activation_date
String
Mandatory
2019-07-26, 17:33:14 Date and time when the affiliate account is activated
reminder
Object
collection
Object
product
Object
tariff
Object
payment_link
Object

Simulations are done only for test transactions

Run