Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Zip Redirect Component

Add Zip to an existing Components integration.

If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to the Zip's website where they can complete the payment.

When making a Zip payment, you also need to:

  1. Collect shopper details, and specify these in your payment request. Zip uses these for risk checks.
  2. Provide information about the purchased items in your payment request.
  3. Include Zip in the list of available payment methods.
  4. Handle the redirect.

Before you begin

This page explains how to add Zip to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Zip integration:

  1. Make sure that you have set up your back end implementation for making API requests.
  2. Add Zip in your test Customer Area.

Show Zip in your payment form

Include Zip in the list of available payment methods.

We provide logos for Zip which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, you need to:

  1. From your server, make a /payments request, specifying:

    • paymentMethod.type: Set this to zip.

    • returnUrl: The URL where the shopper is taken back to in case of a redirection. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

    • paymentMethod.clickAndCollect Optional: 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.clickAndCollect to 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.

    • imageURL Optional: 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.

  1. Pass the action object to your client app.

Handle the redirect

  1. Use the Redirect Component to redirect the shopper to Zip.

  2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:

    • details: The actionComponentData.details object from the Redirect Component.

You receive a response containing:

  • resultCode: Use this to present the payment 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
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.

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:

  1. Create a shopper token.
  2. 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 webhook containing:

  • originalReference: The pspReference of 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:

  • paymentMethod.storedPaymentMethodId: The pspReference from 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.

  • shopperInteractionContAuth.

  • recurringProcessingModel: Subscription or UnscheduledCardOnFile.

For more information about the shopperInteraction and 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.

See also