Accept Zip payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Zip to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your Zip integration:
Build your payment form for ZipZip requires additional shopper details to perform risk checks. When making a Zip payment, you also need to provide the following shopper details:
|Full name||The shopper's first name and last name.|
|Gender||The shopper's gender, if specified.|
|The shopper's email address.|
|Date of birth||The shopper's date of birth, if specified.|
|Telephone number||The shopper's telephone number, if specified.|
|The billing address||The postal address to be included on the invoice.|
|The shopper's delivery preference||The shopper's preference: if they want to use Zip's Click and Collect,
or have the goods delivered to them.
|The delivery address||The postal address where the goods will be delivered.
Required only when the shopper prefers that the goods are delivered to them.
With Zip, the shopper also can have the option to choose Click and Collect, where they pick up and collect their order from a store instead of having the goods delivered to them.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
- countryCode: AU
- amount.currency: AUD
- amount.value: The value of the payment.
- channel: Specify Web, iOS, or Android.
The response contains
We provide logos for Zip which you can use on your payment form. For more information, refer to Downloading logos.
Make a payment
From your server, make a /payments request, specifying:
paymentMethod.clickAndCollectOptional: Set this to true if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.
deliveryAddress Optional: Object that contains the postal address where the goods will be shipped. If the shopper chooses to pick up and collect their order and you set
paymentMethod.clickAndCollectto true, you can omit this object from the request.
billingAddress Optional: Object that contains the postal address to be included on the invoice.
shopperName Optional: Object that contains the shopper's full name, and gender (if specified).
shopperEmail Optional: The shopper's email address.
telephoneNumber Optional: The shopper's phone number.
dateOfBirth Optional: The shopper's date of birth.
lineItems: Object that contains price and product information about the purchased items.
- description: Item description.
- quantity: Number of items.
- amountIncludingTax: Item amount including the tax, in minor units.
- id: Line item ID.
imageURLOptional: URL of an image displayed for the item on the Zip product page — the shopper will see this image when they log into their Zip account. Maximum of 500 characters.
Select a tab below to for payment request samples depending on the shopper's choice:
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for Zip are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful.|
|Cancelled||The shopper cancelled the payment while on Zip's website.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|Error||There was an error when the payment was being processed.||Inform the shopper that there was an error processing their payment. The response contains a
|The shopper has completed the payment but the final result is not yet known.||Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
|Refused||The payment was refused by Zip.||Ask the shopper to try the payment again using a different payment method.|
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful and proceed with the order.|
|OFFER_CLOSED||true||The shopper did not complete the payment.||Cancel the order and inform the shopper that the payment timed out.|
We support recurring transactions for Zip. To make recurring payments, you need to:
Create a token
To create a token, include in your /payments request:
- shopperReference: Your unique identifier for the shopper.
When the payment has been settled, you receive a webhook containing:
pspReferenceof the initial payment.
pspReference: This is the token that you need to make recurring payments for this shopper.
Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.
Make a payment with a token
To make a payment with the token, include in your /payments request:
pspReferencefrom the RECURRING_CONTRACT.
You can also get this value by using the /listRecurringDetails endpoint.
shopperReference: The unique shopper identifier that you specified when creating the token.
recurringProcessingModel: Subscription or UnscheduledCardOnFile.
For more information about the
recurringProcessingModel fields, refer to Recurring transaction types.
Test and go live
Create Zip test accounts using the credentials on Zip's test credentials page. You can then use your test account to make a payment in the test environment.
Check the status of Zip test payments in your Customer Area > Transactions > Payments.
Before you can accept live Zip payments, you need to submit a request for Zip in your live Customer Area.