Zip for API only

Add Zip to an existing API-only integration.

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.

Requirements

Requirement	Description
Integration type	Make sure that you have built an API-only integration.
Setup steps	Before you begin, add Zip in your test Customer Area.

Build your payment form for Zip

Zip accepts additional shopper details to perform risk checks. When making a Zip payment, we encourage you to provide the following shopper details:

Shopper detail	Description
Full name	The shopper's first name and last name.
Gender	The shopper's gender, if specified.
Email	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.
Billing address	The postal address to be included on the invoice.
Shopper's delivery preference	The shopper's preference: whether they want to use Zip's Click and Collect or have the goods delivered to them.
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: The two-letter ISO country code (AU, NZ, or US).
amount.currency: The three-character ISO currency code (AUD, NZD, or USD).
amount.value: The amount of the payment, in minor units.
channel: Specify Web, iOS, or Android.

The response contains paymentMethod.type: zip.

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.type: zip

Select which endpoint you are using:

In the /payments response, check the action object for the information that you must use to redirect the shopper.

Handle the redirect

To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:
- When using the HTTP GET method:
  For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.
- Redirection for mobile integrations:
  For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.
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 redirectResult returned when the shopper was redirected back to your site.
In the response note the following:
- resultCode: use this to present the result to your shopper.
- pspReference: our unique identifier for the transaction.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The 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 `refusalReason`, indicating the cause of the error.
Pending or Received	The shopper has completed the payment but the final result is not yet known.	Inform the shopper that you have 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.

If the shopper closed the browser and failed to return to your website or app, wait for webhooks to know the outcome of the payment. The webhooks you can receive for Zip are:

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.

Recurring payments

We support recurring transactions for Zip. To make recurring payments, you need to:

Create a shopper token.
Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

storePaymentMethod: true
shopperReference: Your unique identifier for the shopper.

When the payment has been settled, you receive a recurring.token.created webhook containing:

type: recurring.token.created
shopperReference: Your unique identifier for the shopper.
eventId: The pspReference of the initial payment.
storedPaymentMethodId: The token that you need to make recurring payments for this shopper.

Make sure that your server is able to receive the Recurring tokens life cycle events webhook. You can set up this webhook in your Customer Area.

Make a payment with a token

To make a payment with the token, include in your /payments request:

paymentMethod.storedPaymentMethodId: The storedPaymentMethodId from the recurring.token.created webhook.
You can also get this value using the /listRecurringDetails endpoint.
shopperReference: The unique shopper identifier that you specified when creating the token.
shopperInteraction: ContAuth.
recurringProcessingModel: Subscription or UnscheduledCardOnFile.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Tokenization.

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.