Zip Drop-in integration

Our Android Drop-in renders Zip in your payment form, and redirects 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.

Before you begin

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

Before starting your Zip integration:

1. Make sure you have set up your back end implementation.
2. Add Zip in your test Customer Area.

Show Zip in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show Zip in your payment form, specify in your /paymentMethods request:

• countryCode: AU
• amount.currency: AUD
• amount.value: The value of the payment.

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

1. Pass the paymentComponentData.paymentMethod to your server.

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

   • paymentMethod: The paymentComponentData.paymentMethod from your client app.

   • 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:

   Deliver goods to shopper Shopper picks up goods (Click and Collect)

   Deliver goods to shopper Shopper picks up goods (Click and Collect)

The /payments response contains an action object with the information needed to redirect the shopper.

If your integration is set up correctly, the action object is passed from your server to the client.

Check the payment result

Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData object.

From your server, make a POST /payments/details request providing:

• details: The actionComponentData.details object from Drop-in.

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:

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:

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:

• eventCode: RECURRING_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: This is the token that you need to make recurring payments for this shopper.

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.

• shopperInteraction: ContAuth.

• 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