Webhook

The notification URL is an automatic push notification that can be sent to a merchant’s notification URL address. This will be initiated when a payment is completed. Note that the URL can be configured per-merchant site.

To set this URL, please contact support@zapper.co.za

Web-Hook Notification Data

Example Web-Hook Notification JSON Body

{
"Reference":"ABCD-EF45-C3D2-A1AB",
"PaymentStatusId":2,
"PosReference":"DEFAB4A6C3D1A1B2",
"PSPData":"",
"Amount":"50.67",
"ZapperId":"HLV8AMJ47RBI",
"UpdatedDate":"2015-06-29T17:54:53.157",
"TipAmount":"5.56",
"VoucherAmount":"0.00",
"ZapperDiscountAmount":"0.00",
"InvoiceAmount":"44.44",
"Vouchers":[
],
"CustomFields":[
]
}

Parameter

Type

Description

Reference

String

This is the unique merchant reference to the existing order (i.e. the table number, check number etc). Max length 30 characters. AKA MerchantOrderId.

PaymentStatusId

Int

2 = Success; 5 = Failed

PosReference

String

The 16 character PosReference that uniquely identifies the printing of the Bill.

PSPData

String

Reserved for future date

Amount

Decimal

The sum of the InvoiceAmount and TipAmount fields. i.e Amount. After adding calculating (InvoiceAmount plus TipAmount), discount vouchers are applied, i.e. subtracted from the Amount. The sum total, i.e. Amount minus Vouchers is the amount that the customer has to pay.

ZapperId

String

A unique Transaction Identifier for the customer.

UpdatedDate

DateTime (UTC)

The date of the transaction.

TipAmount

Decimal

Tip Amount paid by the customer.

ZapperDiscountAmount

Decimal

How much Zapper pays the merchant on the diner’s behalf the first time the diner uses Zapper to make payment. (Note: this is not a discount that would have been shown on the bill, it is applied by Zapper to the diner’s payment).

InvoiceAmount

Decimal

The amount on the bill/check

Vouchers

Dictionary

Key Value Pair of all vouchers used on this payment.