On this page, you can find additional configuration for adding Zip to your Drop-in integration.
Before you begin
This page assumes you have already:
- Built a Drop-in integration.
- Added Zip in your test Customer Area.
API reference
Select which endpoint you're integrating:
This is the default with Drop-in v5.0.0 or later.
Parameter name Required Description shopperName Shopper's first name and last name. shopperEmail The shopper's email address. dateOfBirth The shopper's date of birth. telephoneNumber The shopper's phone number. billingAddress The address where to send the invoice. deliveryAddress The address where the purchased goods should be delivered. lineItems Price and product information about the purchased items.
You can optionally specify animageURL
to have the picture of the item on the Zip product page. The shopper will see this image when they log into their Zip account. The URL must have a maximum of 500 characters.Drop-in configuration
There are no configuration steps specific to Zip required for Drop-in.
Recurring payments
We support recurring transactions for Zip. To make recurring payments, you need to:
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_CONTRACToriginalReference
: ThepspReference
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
: ThepspReference
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. -
shopperInteraction
: ContAuth. -
recurringProcessingModel
: Subscription or UnscheduledCardOnFile.
For more information about the
shopperInteraction
andrecurringProcessingModel
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