To start with you will need a PayPal Business account already setup - the payment gateway will not work with a personal account so please ensure this is correct first. Please also consider whom the payment gateway should apply to (i.e. public, account customers or both), and if freight calculations on the website may need to be implemented at the same time.
Step 1 - Setup checkout method
Login to your PayPal admin portal, then open the “Profile”
> “Business Setup” Page.
Select "process all payments, including credit & debit cards through PayPal". Once correctly selected, the screen should look as per below.
Step 2 - Navigate to auto return settings
Once the above is selected, click on the "settings" option again, this time selecting "Profile & Settings".
Once open, click on the "Selling Tools" tab, and click on the "Update" link in the Website Preferences row.
Step 3 - Configure auto return settings
On the following page please ensure the following settings
The above are the mandatory settings we require for the integration, however the below are the suggested PayPal configuration for the other options on this page;
- Block Non-Encripted Website Payment: Off
- PayPal Account Optional: On
- Contact Telephone Number: Off
- PayPal Express Checkout Settings: No
Ensure to scroll to the bottom of the form and save your settings (via clicking the "Save" button).
Step 4 - Configure PayPal settings in Inzant
Login to the Inzant CMS, then navigate to the "Merchant Settings" page. Here you will need to check the "PayPal" option to be on, and complete the below form.
Use Live Account : ON
PayPal Email Address : please type in your paypal account email address here.
PayPal Token : please paste in the PDT "identity token" copied earlier from the PayPal setup screen.
PayPal Item Name Test: this setting allows you to customise the name of the item that appears in the PayPal payment screen. Note the entire cart is displayed in PayPal as one single item with the total price.
- We suggest using something like "[your company name] Website Cart".
- PayPal Item Number Prefix : This is the prefix that will always sit before the cart ID sent with the order to PayPal.
- We suggest labelling this "Cart # ".
- Currency : AUD
- Note this changes depending on what you want the currency to be, however the above covers Australian transactions.
- Process Pending Payments: ON
- This setting covers payments marked as "pending" by PayPal. This is uncommon, if the setting is OFF then any pending payments will result in a locked cart.
- Locked Cart Pending Message: This message will display when a cart is locked (the user fails to complete the entire payment process and return to the website via the correct workflow).
- Suggested Message: "Your cart has been Locked due to our inability to confirm your payment, please contact our office on [company phone] or [company email] to confirm your payment."
- Failed Payment Message: This message will display when PayPal sends back a response saying the payment failed / declined.
- Suggested Message: "PayPal payment failed to process, please choose a checkout method below."
- Error Message: This message will display if there is a communication issue between Inzant and PayPal and we do not receive sufficient information to process the response from PayPal correctly.
- Suggested Message: "We weren't able to confirm your payment with PayPal, please try again or contact our office on [company phone] or [company email] if an issue occurred."
- Cancelled Payment Message: This message will display if the user cancels the payment in PayPal and is sent back to Inzant.
- Suggested Message: "PayPal payment cancelled, please choose a checkout method below."
Step 5 - Configure Checkout Payment Widget
Now you will need to configure the "Checkout Payment" widget. This will involve navigating the "Pages" page in the CMS, then creating a "Preview" version of the "Checkout Payment" page.
Once the Preview version is open navigate to the "Content" section of the page and open the "checkout Payment" widget configuration.
Now check "Display PayPal" to be ON to either Public, Account customers or both depending on your requirements. Once complete, click "Save & Publish" in the top right of the screen.
Important Note: If you wish to continue to provide alternate checkout methods to your users (i.e. phone based payment for public users, or Account checkout for account customers) then please leave these checkout methods ON.
Step 6 - Create & Upload PayPal transition page Images
Now you will need to create some images that the website will use to custom brand the PayPal interface for you.
You will need to create the below 2 images, and then upload them inot Inzant using the "File Library" interface (i.e. adding them using the file upload function);
PayPal Logo file
This file is basically just your company logo, it gets displayed in the PayPal payment interface whilst the user is making their payment.
It needs to be 190px (width) x 60px (height).
It needs to be in PNG format
the file needs to be named "PaypalLogo" (i.e. resulting in a file being uploaded into Inzant called "PaypalLogo.png")
PayPal Redirect File
This file displays on the loading screen whilst the user if being sent to PayPal to make the payment, so should typically contain your logo, the PayPal logo and a short "please wait whilst we transfer you..." message.
It needs to be 720px (width) x 600px (height).
It needs to be in PNG format
the file needs to be named "PaypalRedirect" (i.e. resulting in a file being uploaded into Inzant called "PaypalRedirect.png")
Please see a couple of examples below;
Example logo image;
Example Redirect image;
Step 7 - Test PayPal order placement & payment on live site
Place a test order and do a test payment via PayPal to ensure everything is working as expected. Some things to be mindful of;
Make sure the user experience throughout the checkout process in PayPal is as expected.
Make sure the cart successfully converts to an order in Inzant.
Make sure the order contains the receipt information in Inzant.
Make sure you can see the information regarding the payment in your PayPal account interface.
Once your happy with the user experience you're all set, the configuration process is complete.