Paylink 3rd party electronic commerce platform integration WooCommerce Paylink 3 Plugin

citypay-paylink-woo-commerce

CityPay Paylink WooCommerce is a plugin that supplements WooCommerce with support for payment processing using CityPay hosted payment forms.

The CityPay WooCommerce plugin is an open source GPLv3 plugin available from https://github.com/citypay/citypay-paylink-woo-commerce

Minimum requirements

  • PHP version 5.2.4 or greater with libcurl support
  • MySQL version 5.0 or greater
  • libcurl version 7.10.5 or later with SSL / TLS support
  • openssl, to current patch levels
  • WordPress 4.0 or greater
  • WooCommerce 2.3 or greater

Automatic Installation

To perform an automatic installation of the CityPay Paylink WooCommerce plugin, login to your WordPress dashboard, select the Plugins menu and click Add New.

In the search field, type "CityPay" and click Search Plugins. Once you have found our payment gateway plugin, it may be installed by clicking Install Now.

Manual installation

The perform a manual installation of the CityPay Paylink WooCommerce plugin, login to your WordPress dashboard, select the Plugins menu and click Add New.

Then select Upload Plugin, browse to the location of the ZIP file containing the plugin (typically named citypay-paylink-woocommerce.zip) and then click Install Now.

Post installation: the plugin settings form

Once the plugin has been installed, you may need to activate it by selecting the Plugins menu, clicking Installed Plugins and then activating the plugin with the name "CityPay WooCommerce Payments" by clicking on the link labeled Activate.

The merchant account, the license key, the transaction currency and other information relating to the processing of transactions through the CityPay Paylink hosted form payment gateway may be configured by selecting the plugin configuration form which is accessed indirectly through the WooCommerce settings page upon selecting the Checkout tab, and clicking on the link labeled CityPay which appears in the list of available payment methods.

You can include the WooCommerce order identifier in the description sent to CityPay for the purpose of including a customer-friendly reference in the email sent to the customer on conclusion of the transaction. This is achieved by specifying {order_id} as part of the descriptive text appearing in the text box labeled Transaction Description.

After the settings for the plugin have been configured, they must be saved by clicking on the button labeled Save Changes before they take effect.

Processing test transactions

To test the operation of an e-commerce solution based on WooCommerce in combination with the CityPay Paylink WooCommerce plugin without processing transactions that will be settled by the upstream acquirer, the check box labeled Test Mode appearing on the plugin settings form should be ticked.

Processing live transactions

To process live transactions for settlement by the upstream acquirer, the check box labeled Test Mode referenced in the paragraph above must be unticked.

Enabling logging

The interaction between WordPress, WooCommerce and the CityPay Paylink hosted payment form service may be monitored by ticking the check box labeled Debug Log appearing on the plugin settings form.

Log payment events appearing in the resultant log file will help to trace any difficulties you may experience accepting payments using the CityPay Paylink service.

The location of the log file is provided on the plugin settings form.

+44 (0)1534 884000