Page History

Step-by-step guide

Provided your Zip merchant account has been set up, the latest Zip version (V2) can be configured easily and quickly in the CMS. 

1. Configure Zip settings

1. Gather Have your Zip account credentials ready.
   
   
2. In the CMS, navigate go to Settings → Settings → Feature Management → Payment & Checkout. 
   
   
3. Select For Buy Now, Pay Later.
   Image Removed
   Ensure , ensure 'Available in CMS' is toggled ON.
   
   Image Added
   
   
4. Click Configure.
   
   
5. In the 'Buy Now, Pay Later Feature Settings' page, click the Zip tab. 
   Image Added
   
   
6. For API Version , select 'V22'. Note - If your site is already using V1, this option will remain after any CSS site version upgrade unless specifically a change was requested.
   
   
7. In Mode, select whether you're configuring Zip this configuration is for your Live site (Production), or  or Stage site (Sandbox).  
   
   
8. Enter the API keys and URL for either Production (Live) or Sandbox:
   Production Public Key OR Sandbox Public Key
   Zip V2 Production API Key = private key for Live
   Zip V2 Production URL = https://api.zipmoney.com.au/merchant/v1/
   Zip V2 Sandbox API Key = private key for Sandbox
   Zip V2 Sandbox URL = https://api.sandbox.zipmoney.com.au/merchant/v1/
   
   
9. To exclude order lines when order details are sent to Zip, tick Exclude OrderLine Items from API Calls. 
   
   
10. Set the following options: 
    Event Logging - toggle this ON. (enabling Enabling this is recommended as any performance issues can be more readily tracked.)
    Auto-Integrate Pending Orders - integrates to integrate orders to the ERP prior to receiving a response from the payment provider, toggle ON.
    
    
11. Surname Override (when blank): this should not be left blank as Zip requires the customer to enter a surname. Please check with Zip if you wish to leave it blank. 
    
    
12. Click Save.
    
    
13. Test the settings by clicking . Click the Test Settings button. A popup message will tell you whether the current settings pass or fail. Note - only the API key is tested.  

2. Set Display Options

Display Options determine control where and how Zip messaging appears on your site. 

1. Set the Display Options as you require:

Display Content in Product Detail - toggle ON to show the Zip logo, tag line & link messaging and link to more info in the product detail Product Detail page.
Image Removed
Image Added

Disable Further Checkout Attempts with Provider for an Order if Declined - toggle ON/OFF as required. if Zip declines payment for an order and the customer re-attempts to pay, to hide Zip as a payment option, toggle ON. Default: OFF 

Min Price of Products to Show Content - the minimum value of a product must meet this minimum in order for Zip content in the Product Detail page to say be before Zip messaging states Zip can be used for payment.

If a product's price is under the minimum value, the message that Zip is only available for orders between the min-max range will be displayed. Note - this message can be edited in 'Zip Payment Under Limit Message' field in the Product Purchase Details Widget. 

Max Price of Products to Show Content - the maximum value of a product must not exceed this maximum in order for Zip content in the Product Detail page to say Zip can be used for paymentcan be before Zip messaging states that Zip is unavailablec.

If a product's price is over the maximum value, the message that Zip is unavailable for this order will be displayed. Note - this message can be edited in 'Zip Payment Over Limit Message' field in the Product Purchase Details Widget. 

If a product's price is within the minimum and maximum values, the following Zip message is shown. Note - this message can be edited in 'Zip Money Summary Message' field in the Product Purchase Details Widget. 

Min Order Total to be Available - the minimum in order for the customer total to checkout pay with Zip. This is validated at checkout. If Zip is selected for payment but the order does not meet this minimum amount, the 'Pay with Zip' button is disabled and this message appears: 
 Image Removed

Max Order Total to be Available - the maximum in order for the customer total to checkout pay with Zip. This is validated at checkout. 

Info
If Zip is selected for payment but the order is

above this maximum amount

not between the minimum and maximum amounts, the 'Pay with Zip' button is disabled and

a message (as for min order total) appears.

this message appears:  Image Added

Use CV Zip Content - the default is OFF. This Copies of the Zip logo and messaging are stored locally as a backup. Default OFF is recommended so that the latest Zip-related content in the Product Details page and the Payment panel in Checkout is supplied comes directly from Zip.  Note - please coordinate with Zip to ensure the feeds are set up on your site. Toggle ON if you want the default Zip content stored locally in BPD to display. Note: the BPD Zip message in the Product Details page is edited in the Product Purchase Details Widget.    for your site   

3. Add Overrides (optional)

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 only B2C users, but not for B2B. In this case, you could set this as an override. 

1. Select the 'Overrides' icon next to the setting you want to customise.
   
2. A In the popup will openwindow, with your the current Global setting is displayed at the bottom. Click Add Override Setting in the Role Overrides section. 
   
   Enter the role name into the lookup and
   
3. Because we want to display the messaging only for the B2C and Public User roles, we toggle Global Setting OFF.
    
4. In the Roles Overrides section, click Add Override Setting. 
5. In Role, select the role from the options presented. 
   Image RemovedImage Added
6. Toggle Override Value on ON. 
   Set Global Setting to ON or OFF. 
   Click 
   
7. To add another Role, e.g. Public User Not Logged In, go through steps 4-6. 
   
   
8. When you have finished, click Confirm to close the window. 
   
   
9. Don't forget to click Save on the feature settings page to save your changes!

4. Edit

Zip messaging and labels

Zip text messaging and labels in certain widgets can be customised.  NOTE -  However, in general for V2, text should default to the Zip brand should be 'Zip' wherever Zip payment options are displayed. 

Other widgets

containing Zip resources: 

• Cart Order Summary Totals widget (in Cart template) - include/exclude Zip payment details when displaying a summary of charges and discounts for an order; text . Messaging can be edited.
• Product Purchase Details widget (in Product detail template) - edit the text that appears when Zip branding is included in the product detail Product Detail page.
• Payment Cancelled widget (in Payment Cancelled Page template) - edit the text that appears when a Zip payment is unsuccessful.

What your customers will see

Zip on your Commerce Vision site 

1. In the Checkout page, the customer can select the selects Zip tab for payment. 

2. When the customer clicks the 'Pay with Zip' button, they are taken to a popup login hosted by Zip where they can sign the Zip popup window displays. They log into their Zip account. 

If payment is successful, the customer is 3. They go through Zip's internal payment proccess.

4. After completion, they are returned to your website. For successful payments, they are taken to the Order Confirmation page on your website. They will also receive an email from Zip confirming payment success.
Image Added

Note - If a payment requires referral (which this happens when the user signs up to Zip when making a during the payment process but their credit check is comes back with 'pending'), the order user will also return to land on the 'Confirmation' page. However, its the order status is 'Pending'. The user will receive an email from Zip once their credit has been approved or rejected. The email will have a link to return to your website where the user can decline or approve the order. 

Image Removed

If payment is declined, either the order is either cancelled and the cart emptied or the customer can return to it to select another method of payment (depending on your Zip settings).   

Additional Information

Related help