No momento, esta página não está disponível em português
Payment-method icon

Zip Drop-in integration

Add Zip to an existing Drop-in integration.

If you are using Android Drop-in v5.0.0 or later:

This payment method requires no additional configuration.

Follow the Drop-in integration guide.

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.

Requirements

Requirement Description
Integration type Make sure that you have built an Advanced flow Android Drop-in integration.
Setup steps Before you begin, add Zip in your 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:

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: