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

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.

Before you begin

Before starting your Zip integration:

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

Build your payment form for Zip

Zip requires additional shopper details to perform risk checks. When making a Zip payment, you also need to provide the following shopper details:
Shopper detail Required Description
Full name -x- The shopper's first name and last name.
Gender -x- The shopper's gender, if specified.
Email -x- The shopper's email address.
Date of birth -x- The shopper's date of birth, if specified.
Telephone number -x- The shopper's telephone number, if specified.
The billing address -x- The postal address to be included on the invoice.
The shopper's delivery preference -x- The shopper's preference: if they want to use Zip's Click and Collect,
or have the goods delivered to them.
The delivery address -x- 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:

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

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

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

    When using the HTTP GET method:
    For security reasons, when displaying 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.

  2. 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.
  3. 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
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 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 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.

See also