Zip

Zip offers flexible buy now, pay later services in both Australia and the US, with a range of products tailored to each market. In Australia, consumers can choose from Zip Pay, Zip Plus, and Zip Money, allowing them to customise their repayment schedule with weekly, two-weekly, or monthly options. In the US, Zip is available as Zip Pay in 4, which offers consumers the ability to pay in four interest-free instalments, with the first payment made upfront and the remaining spread over six weeks. After selecting Zip as their payment method, consumers are redirected to Zip’s website to sign into their account. This page provides detailed information on how to integrate all Zip products available in both Australia and the US.

Payment Method Properties

Available country codesAU, US
Processing (Presentation) currenciesAUD, USD
Settlement currenciesAUD, USD
Consumer currenciesAUD, USD
Channel member tagAU: zip
US: zipus
Scheme name in the settlement fileZIP
Minimum transaction amountAUD 0.01, USD 35
Maximum transaction amountAU:
Zip Pay: Credit limit up to AUD 1,000
Zip Plus: Credit limit from AUD 2,000 to AUD 4,000
Zip Money: Credit limit up to AUD 50,000

US:
Pay in 4: Up to USD 1,500

*Note: The approved credit limit depends on the user's eligibility.
Session timeout168 hours 20 minutes (AU), 1 hour 10 minutes (US)
RefundFull
Partial
Multiple partial
Refund ValidityNo time limit on refund
ChargebackYes
Integration TypeAsynchronous
SandboxPPRO-hosted

👍

Chargebacks

A consumer could dispute a transaction when they are unable to resolve the situation directly with the merchant. A consumer files a chargeback with Zip who subsequently submits a request to PPRO inquiring about the transaction. PPRO notifies the PSP/merchant to provide full details and supporting documents for dispute/complaint. The PSP/merchant is required to provide a response to PPRO within 10 business days. If the dispute is confirmed as a legitimate chargeback by Zip, the funds for the chargeback will then be deducted from one of PPRO’s next settlements. For more information see the Zip Chargebacks.

Transaction Flow

  1. The consumer goes to the merchant's checkout page and selects ZIP as the payment method.
  2. The merchant or Payment Service Provider (PSP) sends a ZIP transaction request to PPRO.
  3. PPRO creates a checkout request to ZIP.
  4. ZIP returns the checkout response and the redirect URL.
  5. PPRO returns the redirect URL to the ZIP payment page.
  6. The merchant/PSP forwards the redirect URL to the consumer.
  7. Consumers use their account credentials to login, or sign up for a new ZIP account.
  8. ZIP returns the application result to PPRO.
  9. PPRO creates a charge request and sends it to ZIP.
  10. ZIP returns the charge status to PPRO.
  11. PPRO forwards the charge status to the PSP or the merchant.
  12. The consumer is redirected back to the merchant's return URL.

👍

Note

In Step 11 above, if the transaction status is unknown, PPRO sends a check status call to ZIP. ZIP then checks the status and returns the result.

Integration

Specific input parameters for the TRANSACTION call

Field NameM/O/CTypeRegexDescription
specin.phoneOStringStandard phone number validationThe consumer’s phone number. For USD, the phone number will be auto-populated on Zip’s checkout page which will be used for receiving OTP.
specin.billingaddrline1OString^.{0,255}$Line 1 of the billing address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.billingaddrline2OString^.{0,255}$Line 2 of the billing address.
specin.billingaddrcityOString^.{0,255}$`City of the billing address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.billingaddrstateOString^.{0,255}$`State of the billing address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.billingaddrpostalcdeOString^.{0,255}$Postal code of the billing address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.billingcntrycdeOString^.{0,255}$Country of the billing address. Only ISO 3166 alpha-2 format is accepted. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.billingaddrfirstnameOString^.{0,255}$First name of the billing address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.billingaddrlastnameOString^.{0,255}$Last name of the billing address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.shippingpickupOBoolean^(false|true)$Accepted value is true or false:

true = item is for for pickup

false = item is for shipping

If this parameter is not passed, the default that will be passed to Zip is 'false' unless the consumer chooses self pickup.
specin.shippingaddrline1OString^.{0,255}$Line 1 of the shipping address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.shippingaddrline2OString^.{0,255}$Line 2 of the shipping address.
specin.shippingaddrcityOString^.{0,255}$City of the shipping address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.shippingaddrstateOString^.{0,255}$State of the shipping address. Recommended field to pass as it may help in investigation, if any dispute arises
specin.shippingaddrpostalcdeOString^.{0,255}$Postal code of the shipping address. Recommended field to pass as it may help in investigation, if any dispute arises.
specin.shippingcntrycdeOString^.{0,255}$Country of the shipping address. Only ISO 3166 alpha-2 format is accepted. Recommended field to pass as it may help in investigation, if any dispute arises.
transientin.orderitemsOStringStringified JSON array

^.{0,255}$
An array of items in the customer's cart that is being purchased, where each item has the following attributes:

name : the name of the item

amount: the amount being paid for this item in major units

quantity: the quantity of the item

type - one of sku, tax, discount or shipping

[{"name":"pen","amount":2.00,"quantity":1,"type":"sku"},{"name":"pencil","amount":1.00,"quantity":1,"type":"sku"}]
Note: amounts should be in major units, accepted values for type are sku, tax, shipping and discount.

Recommended field to pass as it may help in investigation, if any dispute arises.

For standard input parameters, see Input parameters for the TRANSACTION call.

Specific output parameters for the TRANSACTION call

Field NameTypeDescription
SPECOUT.RECEIPTNUMBERStringZip transaction receipt number
SPECOUT.PRODUCTStringZip product name e.g. ZipPay, ZipMoney3, ZipMoney6, ZipMoney12, ZipMoney24, ZipMoney36
SPECOUT.CUSTOMEREMAILStringCustomer's email address
SPECOUT.CUSTOMERFIRSTNAMEStringCustomer's first name
SPECOUT.CUSTOMERIDStringZip customer details
SPECOUT.CUSTOMERLASTNAMEStringCustomer's last name/surname

For standard output parameters, see Output parameters for the TRANSACTION call.

Specific input parameters for the REFUND call

The refunded amount is credited to the consumer’s Zip balance who paid for the original transaction.

Field NameM/O/CTypeRegexDescription
specin.refundreasonOString\*The reason for the refund. If this parameter is not passed, the default that will be passed to Zip is refund.

TRANSACTION call input

tag=zip
&txtype=TRANSACTION
&countrycode=AU
&currency=AUD
&amount=350
&merchanttxid=sale1001
&login=clientlogin
&password=pass123
&contractid=ZIPLTD
&channel=livechannel
&merchantredirecturl=https%3A%2F%2Fwww.example.org%2Ffeedback.php
&notificationurl=https%3A%2F%2Fwww.example.org%2Fnotification.php
&accountholdername=jon+dow
&specin.email=test.tester%40testing.com%0A
&specin.phone=0400000000
&specin.shopperfirstname=jon
&specin.shopperlastname=dow
&specin.shippingpickup=true
&specin.shippingaddrline1=535+Geelong+Road
&specin.shippingaddrcity=Brooklyn
&specin.shippingaddrpostalcde=3141
&specin.shippingaddrstate=VIC
&specin.shippingcntrycde=AU
&specin.billingaddrline1=10+Spring+Street
&specin.billingaddrcity=Sydney
&specin.billingaddrpostalcde=2000
&specin.billingaddrstate=NSW
&specin.billingcntrycde=AU
&specin.billingaddrfirstname=jon
&specin.billingaddrlastname=dow
&transientin.orderitems=%5B%7B%22name%22%3A%22pen%22%2C%22amount%22%3A3.50%2C%22quantity%22%3A1%2C%22type%22%3A%22sku%22%7D%5D&returnmode=urlencodeexttag=zip
22pen%22%2C%22amount%22%3A3.50%2C%22quantity%22%3A1%2C%22type%22%3A%22sku%22%7D%5D
&returnmode=urlencodeext

TRANSACTION call output

STATUS=SUCCEEDED
&TXID=123887123
&ERRMSG=
&CHANNEL=livechannel
&MERCHANTTXID=sale1001
&TAG=zip
&SPECOUT.RECEIPTNUMBER=174123075
&REDIRECTSECRET=dcn94nd2oud8eedhg38dkhed
&FUNDSSTATUS=WAITING

Test Data

For test consumer account credentials, click here.