Zapper Platform
Search…
Zapper Platform
Introduction
Authentication
Zapper Code
Decode
App Linking
Payment Methods
Card
Payments
Processing
Payment Details
Other
Testing
Errors
Powered By GitBook
Decode
This endpoint allows for the decoding of a Zapper-supported QR code to retrieve an invoice.

Zapper-supported QR codes include Zapper's proprietary QR codes, as well as various third-party provider codes:
In order to determine if a QR code is supported by Zapper, it should be sent for decoding so that the value can be verified against the regex below:
^((.*zapper\.com.*)|(.*\.wigroup\..*)|(.{2}\/.{4}\/.{20})|(.*payat\.io.*)|(.*(paynow\.netcash|paynow\.sagepay)\.co\.za.*)|(SK\-\d{1,}\-\d{23})|(\d{20})|(.*\d+\.zap\.pe(.*\n?)*)|(.*transactionjunction\.co\.za.*)|(CRSTPC-\d+-\d+-\d+-\d+-\d+))$
The code should be trimmed before performing the regex match.
get
https://api.zapper.com
/v1/codes/{code}
Decode Zapper Code

All fields are required unless indicated as optional.
Field
Type
Description
merchant
object
The merchant information.
invoice
object
The details of the invoice.

Field
Type
Description
merchantReference
string
The merchant's unique reference.
merchantName
string
The name of the merchant.
currencyISOCode
string
The merchant's three-character ISO 4217 currency symbol.
currencySymbol
string
The currency display symbol.
features
object
Payment feature configuration.

Field
Type
Description
siteReference
string
The identifier of the point of sale till.
currencyISOCode
string
The invoiced three-character ISO 4217 currency code.
amount
number
The invoiced amount in cents.
lineItems
collection optional
A list of line items.
createdUTCDate
string
The date of the invoice creation.
format: yyyy-MM-ddTHH:mm:ss.fffZ.
origin
string
optional
The provider of the invoice.
originReference
string
optional
A unique reference code from the provider.
invoiceReference
string
optional
A unique reference for the invoice.
orderReference
string
optional
A unique reference for the invoice used during payment.
state
string
optional
The current state of the invoice.
Either "open" or "closed"

Product code or stock keeping unit (SKU) is required.
Field
Type
Description
name
string optional
The friendly name of the line item.
productCode
string conditional
The product identifier.
sku
string conditional
The stock keeping unit code.
unitPrice
string
The price for a single unit in cents.
categories
collection optional
A list of names or codes used to group items.
quantity
number optional
The number of items, defaults to 1 if not supplied.

Field
Type
Description
amount
object optional
Feature configuration for the amount field.
orderReference
object optional
Feature configuration for the orderReference.
tip
object optional
Feature configuration for tip.

Field
Type
Description
editable
bool
Can the amount be edited.

Field
Type
Description
label
string
Custom label set by the merchant.
editable
bool
Indicates if the reference is editable.
required
bool
Indicates if it is mandatory to send the orderReference during payment.

Field
Type
Description
enabled
bool
Indicates if a tip can be captured.
Previous
Authentication
Next - Zapper Code
App Linking
Last modified 4mo ago
Copy link
On this page
Identifying Zapper-supported QR Codes
get
Decode Zapper Code
Response
Merchant
Invoice
Line Items
Features
Amount
OrderReference
Tip