Page History

Overview

Important - This help page refers to zip's v1 API settings, where your site has to select either zipMoney (default) or zipPay for display and integration purposes. V1 has been superseded by V2, which is currently supported by Commerce Vision. V2 does not require selection between zipMoney or zipPay. See documentation on zip V2. 

...

Step-by-step guide

...

V1 set up

1. 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.
   
   
2. Gather your zip account credentials (i.e. your base and handover URLs and Authorisation Token).
   
   
3. In the CMS, navigate to Settings → Feature Management → Payment & Checkout. 
   
   
4. Search for Toggle ON Buy Now, Pay Later, or select the Payment & Checkout tab.
   Image Removed
   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.
   Image Removedthen click Configure.
   
   Image Added
5. Select the Zip tab.
   
   
6. In Zip Provider, select either 'ZipMoney' or 'ZipPay'. (The default is 'ZipMoney'.) Note - Selection only determines which branding assets are displayed on your site. It has no impact on customers' use of either zip product for payment.  
    
   
7. For API Version , select V1. Note - If if your site is already using V1, this option will remain after any CSS upgrade. You can change to V2 if you wish.  
   
   
8. Set the Mode based on whether you're configuring zip for your Live site (Production), or Stage site (Sandbox).  
   
   

9. 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
     
     
     

10. 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.
    
    
11. Once all settings have been configured and you're ready to go, scroll back to the top and Save.
    
    
12. 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.

1. 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 A popup message will confirm whether the current settings are correct.

Set Display Options

Display Options determine where and how zipPay/zipMoney appears on your site. 

1. Set the Display Options as you require:

Display Content in Product Detail - toggle on ON to show the zip logo & info , tag line and link 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 ON / off 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.Zip. Note - if the total is below this amount, the customer will be informed they cannot use Zip. 

Max Order Total to be Available - the order total must not exceed this maximum in order for the customer to checkout with zipZip. Note - if the total is above this amount, the customer will be informed they cannot use 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.  

...

Default: OFF. When off, Zip content in the product page and checkout pages come directly from Zip. 'OFF' is recommended so that your site will automatically display Zip's latest information. IMPORTANT - Communicate with Zip as this option requires assistance from zip.
If this option is ON, default Zip content stored in BPD is displayed instead. Note - you can edit the tag line and link text in the Product Purchase Payment Widget.   

Adding Overrides

You can override any of the display feature settings based on the user's Role.

...

1. Select the 'Overrides' icon next to the setting you want to customise.
   
2. A popup will open, with your current Global setting displayed at the bottom. Click Add Override Setting in the Role Overrides section. 
   Image RemovedImage Added
3. Enter the role name into the lookup and select the role from the options presented. 
   Image RemovedImage Added
4. Set the role override value for this setting. 
   Image RemovedRepeat steps 2-4 if you wish to override the global behaviour for other roles. 
   
   
5. Click Confirm to close the window. 
   
   
6. Don't forget to click Save on the feature settings page to save your changes!

Additional Information

...

Related

...

help