Overview
zipPay and zipMoney are popular Buy Now, Pay Later options that Commerce Vision supports for BPD. Your customers can get their goods now, and pay for them over time in manageable installments. zip offers two API versions, V1 and V2. Both are supported in BPD. Configuring zipPay / zipMoney for your website is quick and easy, provided you have already established a merchant account with zip. For further information see our comparison page, or visit zip at https://zip.co/.
Prerequisite alert!
Before you can begin offering zip payment options to your customers:
- your website must be running version 3.99+, and you'll need a merchant account with zip. Note that you can select between V1 and V2 of the API.
- For V1, Zip must also set up the webhook URL for you. It should be in the following format:
ZipPay - https://www.yourwebsite.com.au/api/zipwebhookhandler/zip?mode=pay
ZipMoney - https://www.yourwebsite.com.au/api/zipwebhookhandler/zip?mode=money
The V1 API will not work without this webhook.
Step-by-step guide
For V2 set up, scroll down to the relevant section or click here for V2 set up.
V1 set up
- Contact your Zip Account Manager and ensure the webhook URL has been set up for your site (see info box above). Without this, orders will not integrate to your ERP.
Do not proceed to step 2 until you have the webhook and confirmation that it's ready to use.- Gather your zip account credentials (i.e. your base and handover URLs and Authorisation Token).
- In the CMS, navigate to Settings → Feature Management.
- Search for Buy Now, Pay Later, or select the Payment & Checkout tab.
- Click 'Configure' on the Buy Now, Pay Later feature. (If no Configure option is visible, click the 'Contact to Enable' button and our support team will be notified of your request.)
- In the Provider Selection section, select either zipPay or zipMoney from the dropdown. At the time of writing, it is only possible to offer one or the other; not both.
- For API Version , select V1. Note -If your site is already using V1, this option will remain after any CSS upgrade. You can change to V2 if you wish.
- Set the Mode based on whether you're configuring zip for your Live site (Production), or Stage site (Sandbox).
Enter your Merchant IDs and Keys in the relevant fields (Production or Sandbox, depending on which of your sites you're configuring). You can find these in your Zip Dashboard under Integration Details on the 'Settings' menu:
Production Merchant Unique ID = Public Key
Production Legacy API Key = Secret Key
- Set the following options:
Event Logging - toggle this ON (recommended)
Auto-Integrate Pending Orders (zipMoney only) - integrates orders to the ERP prior to receiving a response from the payment provider.- Once all settings have been configured and you're ready to go, scroll back to the top and Save.
- Test the settings by clicking the Test Settings button. You will be informed whether the current settings are correct.
V2 Set Up
Version 2 does not use web hooks. If a payment requires referral (which happens with ZipMoney and the user signs up when making a payment but their credit check is 'pending'), the order will go to the 'pay ok' page with a 'Pending Approval' message. The user will get an email from Zip once their credit has been approved or rejected. The email will have links to decline or approve the order. Clicking on those links will take the user to your 'pay return' page where they can either decline or complete the order.
- Perform steps 1-6 as for V1 set up.
- For API Version , select V2.
- Set the Mode based on whether you're configuring zip for your Live site (Production), or Stage site (Sandbox).
- Enter the API keys and URL for either Production or Sandbox:
Zip V2 Production API Key = private key in Live
Zip V2 Production URL = https://api.zipmoney.com.au/merchant/v1/
Zip V2 Sandbox API Key = private key in Sandbox
Zip V2 Sandbox URL = https://api.sandbox.zipmoney.com.au/merchant/v1/- Set the following options:
Event Logging - toggle this ON (recommended)
Auto-Integrate Pending Orders (zipMoney only) - integrates orders to the ERP prior to receiving a response from the payment provider.- Once all settings have been configured and you're ready to go, scroll back to the top and Save.
- Test the settings by clicking the Test Settings button. You will be informed whether the current settings are correct.
Set Display Options
Display Options determine where and how zipPay/zipMoney appears on your site.
- Set the Display Options as you require:
Display Content in Product Detail - toggle on to show the zip logo & info on the product detail page, which launches a pop-up explaining the details of the payment option.
Disable Further Checkout Attempts with Provider for an Order if Declined - toggle on / off as required.
Min Price of Products to Show Content - the value of a product must meet this minimum in order for zip content to show on the detail page.
Max Price of Products to Show Content - the value of a product must not exceed this maximum in order for zip content to show on the detail page.
Min Order Total to be Available - the order total must meet this minimum in order for the customer to checkout with zip.
Max Order Total to be Available - the order total must not exceed this maximum in order for the customer to checkout with zip.
Use CV Zip Content - toggle on if you want default Zip content in BPD to display. If off, zip image and product tag line will come from zip.
About Overrides
You can override any of the display feature settings based on the user's Role.
For example, you may wish to display the zip info box on the Product Detail page for B2C users, but not for B2B. In this case, you could set an override.
- Select the 'Overrides' icon next to the setting you want to customise.
- A popup will open, with your current Global setting displayed at the bottom. Click Add Override Setting in the Role Overrides section.
- Enter the role name into the lookup and select the role from the options presented.
- Set the role override value for this setting.
- Repeat steps 2-4 if you wish to override the global behaviour for other roles.
- Click Confirm to close the window.
- Don't forget to click Save on the feature settings page to save your changes!
Additional Information
| Minimum Version Requirements |
|
|---|---|
| Prerequisites |
|
| Self Configurable |
|
| Business Function |
|
| BPD Only? |
|
| B2B/B2C/Both |
|
| Ballpark Hours From CV (if opting for CV to complete self config component) |
|
| Ballpark Hours From CV (in addition to any self config required) |
|
| Third Party Costs |
|
| CMS Category |
|
Related Help
