Home

(Script tags will be stripped)


The first API call you will make in processing a zip in-store payment is a call to our [/purchaserequests](🔗) endpoint. This request is made once a customer provides their Zip pin / barcode for the transaction.
This API call will contain:
  • Order information
  • The customer in-store pin / barcode
  • Store location information
The Zip API response will contain:
  • An order reference - to identify the newly created order
  • An order status - This will return as 'pending'
This /purchaserequests API call should be made from your server and not directly from the client front end.
<br>
921


## Amount and order reference
The total amount to be paid via Zip should be passed in your request as the 'payAmount'. This value will be deducted from the customers available funds.
Your transaction reference for the payment should be passed as 'refCode' . This should be the reference that you would like to appear on your Zip Disbursement Report.
An example of passing these is below:


## Order information
Zip require certain customer order details to be passed at the time of purchase as below:
  • Total amount in AUD
  • Order Items
Here is an example of how this information can be passed:


### Items
When a customer order is created, the item details should be passed in the purchase request to Zip. Below is an example of how this could look:


### Discounts
The majority of POS systems support some form of discount code or promotion feature. In these scenarios, in order for the checkout sums to add up as expected, Zip require these discount amounts to be passed to us in the /purchaserequests API call.
The way this should be handled, is by simply adding an additional 'item' to the request of 'type: discount' e.g.


## Customer 6-digit pin / barcode
This is the key to identifying the customer account and verifying the available funds for the order.


## Store location information
Each order must identify:
  • The transacting store
  • The staff reference
  • The device reference
The store 'Location ID' is a value provided by the Zip team for each store location. 
The staff and device references are your own references for each and need not be communicated to Zip. These will simply be used to assist in troubleshooting any issues in the order logs:
This can be passed as below:


## Platform Identifier
Platfrom Intgerations Only
This is an identifier that must be sent for platform integrations that will have many Zip partners using the one integration.
As a part of all in-store channel partner certifications, Zip require a piece of metadata to be sent in all requests that identifies the 'Platform' that is processing a transaction.
This is simply passed in all POST /purchaserequests requests inside the payload within the 'metadata' object.
Below is an isolated example:


## The full request
An example payload can be found below:


<br>
<br>
Polling the order status
Once the order has been triggered, the order status must the begin to be repeatedly checked until the order status is 'approved'. This is detailed in [Polling the order status](🔗)