Webhook Notification Model: 1.3.0

Webhook Notification Model: Zapper 1.3.0
Field
DataType
Description
invoiceReference
string
Zapper's invoice reference
invoiceExternalReference
string
Merchant's invoice reference
currencySymbol
string
The currency symbol
currencyISOCode
string
The currency ISO code of the invoice
invoicedAmount
number
The invoiced amount in cents
paymentReference
string
Zapper's payment reference (Zapper ID) 
paymentUTCDate
string
The date of the payment
status
​PaymentStatus​
The outcome of the payment
tipAmount
number
The tip amount paid by the customer in cents
tenderedAmount
number
The total tender amount paid by customer (including tips and vouchers)
vouchers
Array<Voucher>
A list of voucher amounts and who is liable respectively
customer
​Customer​
The Customer's first and last name
siteId
number
The Zapper Merchant Site ID
siteReference
string
The identifier of the point of sale till. This is required for routing of Zapper payments and invoices.
transactionProcessorReference
string
The transaction id sent to the payment processor
transactionProcessorId
string
The transaction id given by the payment processor
Example of a Zapper Payment Notification webhook body:
1
{
2
    "status": 1,
3
    "vouchers": [
4
        {
5
            "amount": 100,
6
            "merchantLiable": true
7
        }
8
    ],
9
    "currencySymbol": "R",
10
    "currencyISOCode": "ZAR",
11
    "customer": {
12
        "firstName": "Adam",
13
        "lastName": "E"
14
    },
15
    "invoicedAmount": 1000,
16
    "paymentReference": "8828NV78V30X5N0VY3",
17
    "paymentUTCDate": "2019-09-26T13:44:19.8925818Z",
18
    "invoiceReference": "invoiceReference1234",
19
    "invoiceExternalReference": "merchantOrderId1234",
20
    "tenderedAmount": 1100,
21
    "tipAmount": 100,
22
    "siteId": 1234,
23
    "siteReference": "siteReffy2",
24
    "transactionProcessorReference": "ghr-red-vbf-1231",
25
    "transactionProcessorId": "5938593"
26
}
Copied!
PaymentStatus
Value
Description
1
Success
2
Failed
Customer
Field
Datatype
Required
Description
firstName
string
Yes
The name of the customer
lastName
string
Yes
The last name of the customer
Voucher
Field
Datatype
Required
Description
merchantLiable
bool
Yes
Is the merchant liable for the tender
amount
number
Yes
The redeemed amount in cents

Payment Notifications - Previous

HTTP Webhook

Webhook Notification Model: 1.2.0

Last modified 7mo ago

Copy link

Contents

Webhook Notification Model: Zapper 1.3.0

PaymentStatus

Customer

Voucher