Payment Notification

Allows the polling of the Zapper Hub to receive payments made against open invoices.

get
Fetch payment notification

http://zapperhub/api/v1/invoice/:reference/payment
Payment notifications will be returned one at a time and once only
Request
Response
Path Parameters
reference
required
string
The reference for an active invoice
200: OK
{
"currencyISOCode": "ZAR",
"customer": {
"firstName": "John",
"lastName": "Bam"
},
"invoicedAmount": 182,
"paymentReference": "GWVW8J2L11ENKD5G97",
"paymentUTCDate": "2019-09-17T14:45:10.476Z",
"reference": "referenceXYZ123",
"status": 1,
"tenderedAmount": 190,
"tipAmount": 18,
"vouchers": [
{
"amount": 10,
"merchantLiable": false
}
]
}
404: Not Found
No payment found
​

Invoices sent by merchants are typically short-lived, and are expected to be recycled various times throughout a business day. This often means that invoice references are not unique to a single invoice.

In the event that your business recycles invoices and communicates recycled invoice references to the Zapper Hub, payment notification returned may vary.

Payment Response

Field

Datatype

Required

Description

reference

string

Yes

The invoice reference

currencyISOCode

string

Yes

The ISO code of the transaction

invoicedAmount

number

Yes

The amount of the invoice in cents

paymentReference

string

Yes

Zappers unique payment reference

paymentUTCDate

string

Yes

The date and time of payment completion in ISO format

status

PaymentStatus

Yes

The outcome of the payment

tipAmount

number

Yes

The amount given as a tip in cents

tenderedAmount

number

Yes

The amount the customer paid towards the bill in cents (including vouchers and tips)

vouchers

array<Voucher>

Yes

A list of vouchers used

customer

Customer

Yes

The person conducting the transaction

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