Configuring PayPal as a Payment Gateway

Configuring PayPal as a Payment Gateway

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.

PayPal Components

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 are set;

  • Auto Return – On
  • Return URL – [Your Website]/paymentgatewaypaypalconfirmation
  • Payment Data Transfer – On
    • Then copy the PDT Identity Token and paste it into a word or notepad file, this is what you will paste into the “PayPal Token” field in the Inzant CMS to configure the payment gateway.
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).



Inzant Components

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
    • This setting refers to using a live account versus a test account.
  • 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.



    • Related Articles

    • Configuring SecurePay as a Payment Gateway

      To start with you will need a SecurePay Online Payments account - this is 100% required so get this process started before you need the site up and running as it could take a while for SecurePay to approve your application. Please also consider whom ...

    • Should I configure a Payment Gateway for my website?

      There are a number of different Payment Gateway options available to configure on your website, at this stage PayPal, SecurePay & ANZ Secure Gateway. There are a number of things to consider before implementing a payment gateway; Do all customers ...

    • ANZ Secure Gateway - Renewing Access / Security Keys

      The security credentials that CyberSource will provide to enable the Inzant website to connect to your CyberSource account will expire after 12 months, meaning you'll need to login and create new versions every year. Luckily this is very simple and ...

    • Configuring MYOB AccountRight Integration

      Hint: to view any of the images in this guide in more detail you can click on it for a more detailed version. To close the image popup you can click the cross in the top right of screen. Opening the Integration To modify an existing MYOB AccountRight ...

    • Configuring Google Analytics in the Inzant CMS

      Step 1 First login to your google analytics account and setup a new property. Copy the google script provided and paste this into the “Analytics” section of the Inzant Website section, on the “Analytics” tab. Step 2 As part of this process google ...

    • Popular Articles

    • Home Screen and Navigating the System

      The Home Screen The home screen is the start up screen for the App. It contains links to all the other major screens and provides some KPI information and access to your schedule. In this article we will discuss all the links so you can navigate ...

    • Creating a Retailer

      This article provides a short walk-through tutorial on the steps required when creating a new Retailer Using the Inzant Sales app. To Create a New Retailer touch 'Retailers' on the left of the screen. You will now be able to view a list of previously ...

    • Setting a Retailer to have Website access from the Management Portal

      To enable customers access to the B2B Portal or Website, you need to allow the Contact on a Retailer to have access. After logging into the Inzant Sales Management Portal you'll need to navigate to the Contact or Retailer in question. Finding a ...

    • Inzant Website CMS User Manual

      The latest version (currently version 1.4) of the CMS User Manual is attached, which you can download and use as required.

    • Creating Hyperlinks

      There are two main areas within the CMS that hyperlinks can be created; In a specific content zone provided by a widget. In the CK Editor content entry zone. Both zones offer the same 3 basic link types, Internal URLs, External URLs and Mailto ...

    • Recent Articles

    • Management Portal - Adding a Pricing Rule Walk Through Video

      Watch the linked video as we walk through creating a new pricing rule, set conditions for discounts, select products, choose applicable price lists, and schedule the rule for auto-publishing. Check out the detailed steps and explanations below to ...

    • Performing a Hard Reset on an iPad

    • Adding a Favourites List to a Retailer

      In this video, I will show you how to add a favourites list to a retailer. I will guide you through the steps, including selecting the retailer, navigating to the favourites section, and adding a list. I will also explain how to choose the contact ...

    • Accessing and Managing Favourites Lists

      In this video, I will show you how to access and manage your favourites lists on our platform. I will guide you through the steps to access your favourites list, apply filters, and view specific categories. Additionally, I will demonstrate how to add ...

    • Creating Bespoke Favorites Lists for a Contact

      In this video, I will show you how to create a bespoke favorites list for a specific contact. Sometimes, certain contacts may have unique preferences, and it's important to cater to their needs. I will guide you through the process of selecting the ...