Invoices
post
https://api.zapper.com/business
/api/v1/merchants/{merchantId}/sites/{siteId}/invoices
Upload invoice
The upload invoice endpoint will return a "reference" response header which is used to identify the invoice in subsequent requests.
This is useful in scenarios where an image is returned instead of the invoice response model.
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 used by a business are not unique to a single invoice.
The default representation will only be active for 1 hour.
In the event that your business recycles invoices and communicates recycled invoice references to the Zapper Platform, payment notifications returned may vary.

LineItems

Line-items can be included in your invoices, allowing you to take advantage of Zapper's itemised vouchers and better promote specific items.
Product code or stock keeping unit (SKU) is required
Field
Datatype
Required
Description
name
string
No
The friendly name of the line item
productCode
string
Conditional
The product identifier
SKU
string
Conditional
The stock keeping unit code
unitPrice
number
Yes
The price for a single unit in cents
categories
array<string>
No
A list of names or codes used to group items
quantity
number
No
The number of items, defaults to 1 if not supplied

SubMerchant

Submerchant information is required for aggregator partners with their own merchants.
Field
Datatype
Required
Description
id
string
Yes
The identifier for the submerchant.
name
string
Yes
The name of the submerchant.
mcc
string
Yes
The merchant category code.
msisdn
string
Yes
The MSISDN of the submerchant or aggregator.
location
object
Yes
The location data for the submerchant. See the model below.

Location

Location information that must be submitted with the submerchant information
Field
Datatype
Required
Description
address
string
Yes
The submerchant address. Only letters, numbers and spaces will be accepted. All other characters such as commas, periods, hyphens etc. should be removed prior to submission.
state
string
Yes
The state province. Only allows up to a 3 letter code. e.g KZN
countryCode
string
Yes
The country code. Only the three letter ISO Alpha-3 code is accepted. e.g. ZAF
postalCode
string
Yes
The postal code. Only numbers accepted.
city
string
Yes
The city name. Only letters and spaces accepted.
delete
https://api.zapper.com/business
/api/v1/merchants/{merchantId}/sites/{siteId}/invoices/{reference}
Close Invoice by Zapper's reference
delete
https://api.zapper.com/business
/api/v1/merchants/{merchantId}/sites/{siteId}/invoices
Close Invoice by Merchant's reference

Representations

Representation-Types

Representation-Type
Description
Limitations
Category
zappercode/v2
A legacy Invoice Representation which includes the merchant Info, invoice amount and other metadata such as instructions to enable/disable certain client features (e.g. show tip and split bill options)
    Does not support line items
QR Code
zappercode/v6
Similar to v2 in that the code includes some of the invoice information within it, however, the invoice details are encoded and compressed which allows the inclusion of line-items (facilitating line-item voucher support)
    Can grow into a dense QR Code which may be difficult to scan with low end cameras.
QR Code
triggercode/transient
A short string with only an identifier to a backing value on server side, i.e. No other information is stored within the code. QR Codes are less dense and easier to scan as a result. Ideal for use in restaurants when a code of limited length is printed onto a bill
    Fetches Invoice from Zapper server before displaying to user
    Only active for 1 hour
QR Code
triggercode/dynamic
A physical printed code with only an identifier to a backing value. This code is pre-provisioned on a stand and provided to the merchant. The merchant can then assign the code to a specific site/till.
Invoice uploads will automatically update/clear the server side backing value. This is ideal for retail scenarios where physical codes are set up on the counters at each till.
    Fetches Invoice from Zapper server before displaying to user
QR Code
deeplink/zappercode/v2
A special shareable link including a v2 Zapper Code that when clicked, takes the user to the pay screen of the Zapper App
    Some older devices do not link directly through to app
    Does not support line items.
Link
deeplink/zappercode/v6
A special shareable link including a v6 Zapper Code that when clicked, takes the user to the pay screen of the Zapper App
    Some older devices do not link directly through to app
Link
________________________

Supported Accept Headers For Representation Categories

If the Accept header is set to "application/json", the Representation-Type header is ignored
If the Accept header is set as "text/plain", but the caller requires a QR Code, either generate the QR Code from the string that is returned or change the accept header to "image/svg+xml" or "image/png" to have the QR Code generated by the invoice service.
For Representations categorized as "Link", only the text/plain header is supported.
Representation Category
Supported Accept Headers
QR Code
    Accept: text/plain
    Accept: image/svg+xml
    Accept: image/png
Link
    Accept: text/plain
Last modified 11d ago