Overview
WooCommerce is a plugin that integrates easily with any website built on WordPress. The plugin helps merchants turn their websites into fully functional WordPress eCommerce platforms with just a few clicks.
WooCommerce offers online retailers a suite of services including payments, marketing, shipping, and customer engagement tools to simplify the process of running an eStore for small and enterprise merchants.
Prerequisites
Before installing the Verifone Hosted cart you must meet the following prerequisites:
- Install a WordPress version of at least 5.5.1
- Install the WooCommerce plugin (you can download the latest plugin version from https://woocommerce.com/)
- In the WooCommerce admin panel, under WooCommerce -> Settings -> General, you need to set the Default Customer Location to something other than the "No location by default" setting.
WooCommerce Integration Settings
Installation
This tutorial was written using the default WordPress theme. Other themes may have moved certain menu elements from their original location.
Installation of the Verifone Hosted cart plugin can and should be done just like any other plugin. Overall, there are two possible ways of installing the plugin:
- via the UI
- manually, by copying the plugin files to the appropriate location inside the WordPress installation.
Installation via the UI
Follow these steps to install the Verifone Hosted cart via WordPress:
- Log in to the WooCommerce admin panel (generally located at <URL>/wp-admin).
- Navigate to Plugins and click on Add new.
3. On the Add Plugins page, click on Upload plugin.
4. Click on Choose File, select your file (The plugin folder must be in a .zip format. No other format is accepted at this time), and hit Install now.
5. After installing the plugin navigate to Plugins → Installed Plugins (or simply use the navigation menu on the left-hand side) and click on the Activate to enable the plugin.
Manual installation
To install the plugin manually by copying the plugin files to the appropriate location inside the WordPress installation, follow these steps:
- Navigate to your WordPress installation folder.
- Inside it, you should see a folder called wp-content. Navigate to that folder.
- Inside wp-content another folder called plugins should exist. Navigate to the plugins folder.
- Inside the plugins folder, copy and paste ALL the verifone-hosted cart files as they are.
- If you cannot see the folders mentioned above, then your WordPress installation is incorrect.
WooCommerce Configuration
After installing the plugin, you need to configure the correct credentials.
1. On the WooCommerce dashboard, navigate to WooCommerce → Settings and click on Payments.
2. In the Payments tab, click on Verifone Hosted Cart.
3. The configuration page should look like displayed below:
3.1 General settings
The general settings area allows the customization of the look and feel of the payment integration as well as a few other general settings:
- Title: This allows you to customize the name of the payment method as displayed to the shopper.
- Description: This allows you to customize the description of the payment method as displayed to the shopper.
- Payment mode: You can switch between live orders and test orders in the plugin. Test orders are dependent on having an account set up in the CST environment.
- Region: This allows the merchant to pick the mirror they want to use for best performance. Available regions are Europe, Middle East and Africa (EMEA), North America (NA), and New Zealand and Australia (NZAU)
- Payment display: This allows you to switch the way the integration is done. It can support either as a Hosted Payment Page (shopper is redirected to finish the payment) or as an iFrame integration (shopper will see the payment form embedded in the checkout page).
- Manual capture: Every payment can be configured to
- No – payment is authorized and captured automatically, as one operation
- Auth – payment is authorized and, if the amount is available, then a hold is set for 7 days
- Pre-Auth – payment is authorized and, if the amount is available, then a hold is set for 30 days
3.2 Card credentials
The card credentials settings area allows the configuration of the details needed in order to accept credit card payments.
The mandatory fields are:
- User ID – the user id of the user that generated the API Key in Verifone Central. You can find it in your Verifone Central account, under Profile → API Keys
- API Key – the value of the API Key created in Verifone Central. Read here how to get your API Key. Both the User ID and API Key are mandatory fields for the configuration of the plugin.
- Entity ID – the unique entity id of the organization that is accepting the payments. The Entity ID can be found in Verifone Central, under Administration → Organisations. The 'Organisation ID' listed is the Entity ID required for configuring the plugin.
- Payment Contract ID – the unique id of the payment contract configured to accept credit card payments. The payment contract can be found in the Verifone Central, under Administration → Payment Contract Providers. The 'Payment Provider Contract ID' listed is the Payment Contract ID required for the plugin configuration.
- 3DS contract ID – the unique id of the 3DS provider contract configured to authenticate the credit card transactions. The 3DS Contract ID can be found in Verifone Central, under Administration → 3-D Secure Provider Contracts. Select the 3DS facility required. The ‘3-D Secure Contract ID’ listed is the 3DS Contract ID needed for the plugin configuration.
3.3 PayPal settings
The credentials necessary to accept PayPal (see country availability) as a payment method must be configured in this area:
- PayPal enabled – enable or disable PayPal as a payment method
- PayPal Contract ID – the unique ID of the contract configured to process PayPal transactions
- Test PayPal Contract ID – the unique ID of the contract configured to process PayPal transactions on the CST environment for testing purposes
3.4 Apple Pay settings
The credentials necessary to accept Apple Pay (see country availability) as a payment method must be configured in this area:
- Apple Pay enabled – enable or disable Apple Pay as a payment method
- Apple Pay Contract Id – the unique ID of the contract configured to process Apple Pay transactions
- Test Apple Pay Contract Id – the unique ID of the contract configured to process Apple Pay transactions on the CST environment for testing purposes
- Apple Pay 3ds Contract Id – the unique id of the 3DS provider contract configured to authenticate the Apple Pay transactions
- Test Apple Pay 3ds Contract Id – the unique id of the 3DS provider contract configured to authenticate the Apple Pay transactions in the CST environment used to test transactions
- Strong Customer Authentication (SCA) compliance level – specify the SCA compliance level required, as instructed by the Verifone team
- Apple Pay 3DS – enforce 3DS for transactions done with Apple Pay
3.5 Google Pay settings
The credentials necessary to accept Google Pay (see country availability) as a payment method must be configured in this area:
- Google Pay enabled – enable or disable Google Pay as a payment method
- Live Google Pay Contract Id – the unique ID of the contract configured to process Google Pay transactions
- Test Google Pay Contract Id – the unique ID of the contract configured to process Google Pay transactions on the CST environment for testing purposes
- Google 3ds Contract Id – the unique id of the 3DS provider contract configured to authenticate the Google Pay transactions
- Test Google 3ds Contract Id – the unique id of the 3DS provider contract configured to authenticate the Google Pay transactions placed in the CST environment
- Strong Customer Authentication (SCA) compliance level – specify the SCA compliance level required, as instructed by the Verifone team
- Google Pay 3DS – enforce 3DS for transactions done with Google Pay
3.6 Payment options
The payment options allow the general behavior of the order to be changed:
- Card 3DS – enforce 3DS on transactions paid with credit card
- Complete Order on Payment – change the status of the order once the payment is processed
- Chose Yes if you want the order to be marked as complete automatically once the payment is done
- Choose No if you want to manually mark orders as complete
3.7 Advanced options
The advance options allow the more advanced settings to be tuned:
- Enabled/Disable cURL verify host and peer – depending on the settings of the web hosting package where WordPress is running, requests might time out due to security policies enforced to cURL requests. If you have troubles with the plugin requests timing out, select the checkbox.
- Enabled/Disable overlay when placing an order – select if you want to block the shopper from triggering any other change on the checkout page after they’ve placed the order
- Enable/Disable emptying buyer shopping cart when redirecting to Verifone – This option will empty the shopping cart when the buyer is redirected to Verifone. Keep unchecked if you want the buyer to be able to recover their cart until they have successfully paid for the order.
- "Place order" button text – Customize the text used for the place order button on the checkout page.
4. Click Save changes to complete your integration.
Secure Card Capture Key
Create a public key for Secure Card Capture to start accepting eCommerce transactions. You do not need to use this key for the plugin configuration, it simply needs to be created to ensure any card details are encrypted in the browser, so that information can be safely passed from you (merchant) to Verifone.
To generate a public key from your Verifone Central account follow these steps:
- Navigate to Administration → Organisations, and select the required organization.
- Scroll down to the bottom of the page to see the Secure Card Capture area.
- Click on the Create new public key button.
Error handling and troubleshooting
If you encounter any errors during the installation and configuration of the WooCommerce plugin, you can find a log of all errors in the WooCommerce dashboard, under WooCommerce → Status → Logs.
However, it’s highly recommended to visit the WordPress support forums for any questions and concerns.
On the right-hand side of the screen select the log you wish to view and click on the View button.
Common errors
Generally, errors will initially appear due to some misconfiguration:
- Not having created a public key for Secure Card Capture (see section Secure Card Capture Key above)
- Make sure that the user ID and API Key are correct
- Make sure you are not using Test Mode when in fact you meant to use Live mode
- Make sure that the Region is correct
- If using cURL, verify host and peer make sure that both the host and the peer are using TLS
- If you’re using 3DS, make sure that the card actually supports 3DS
- If the plugin appears to not be working make sure that it’s in the correct location
Download the Verifone Payment Module
| Release date | Build | Release notes |
|---|---|---|
| 2021-08-31 | verifone-woocommerce-v2.0.1.zip |
|
