Legacy Model (Deprecated)

Web-Hook Notification Model
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":[
​
    ]
}
Example Web-Hook notification JSON string Body
To support the old webhook service the JSON string format was ported over from the old project. This is activated by setting the encoding field of the webhook config to "string".
"{\"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
String
The sum of the InvoiceAmount and TipAmount fields (in decimal format). 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
String
Tip Amount paid by the customer (in decimal format).
ZapperDiscountAmount
String
How much Zapper pays the merchant on the diner’s behalf the first time the diner uses Zapper to make payment (in decimal format). (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
String
The amount on the bill/check (in decimal format).
Vouchers
array<Voucher>
Voucher collection of all redeemed vouchers for this payment.
CustomFields
array<CustomField>
CustomField collection of all custom fields added for this payment
Voucher Model
Parameter
Type
Description
Name
String
The name of the voucher
Amount
String
The amount redeemed (in decimal format).
CustomField Model
Parameter
Type
Description
Name
String
The name of the custom field
Value
String
The value of the custom field

Webhook Notification Model: 1.2.0

Next - Web

Javascript SDK

Last updated 3 months ago

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	String	The sum of the InvoiceAmount and TipAmount fields (in decimal format). 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	String	Tip Amount paid by the customer (in decimal format).
ZapperDiscountAmount	String	How much Zapper pays the merchant on the diner’s behalf the first time the diner uses Zapper to make payment (in decimal format). (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	String	The amount on the bill/check (in decimal format).
Vouchers	array<Voucher>	Voucher collection of all redeemed vouchers for this payment.
CustomFields	array<CustomField>	CustomField collection of all custom fields added for this payment