README

Magento 2 Payment Module

CityPay Paylink Magento 2 Payment Module is a secure payment method in your Magento2 webshop. Integrating CityPay Paylink with Magento 2 is fast and easy.

To make payments in your Magento 2 webshop, download the CityPay Paylink Magento 2 module here, and you will be able to offer a vast variety of most frequently used national and international online payment methods and solutions for worldwide internet commerce.

Installing CityPay Paylink Payment Module

1. Change to directory where magento is installed (i.e. cd /var/www/html/)
2. Run composer require citypay/magento-paylink
3. Ensure that the plugin is enabled (i.e. using Magento CLI -> magento module:enable CityPay_Paylink)

User Documentation

Configuring the payment module

To configure the module, log in to your administrator backend.

1. Go to Stores -> Configuration -> Sales -> Payment methods and find and click on CityPay Paylink Gateway Settings under OTHER PAYMENT METHODS

Merchant required settings

To be able to use the CityPay Paylink Plugin the merchant must configure their following Required fields:

• Licence Key (CityPay Client LK)
• Merchant Id (CityPay Merchant Id)
• Order Confirmation Email Address (email to which the merchant receipt email go to)
• Postback Host (Internet accessible Base URL for the magento store so that postback can be handled and order status can be updated) *if using localhost in development we suggest using a product like ngrok to create a tunnel so that our postbacks are remotely accessible through the internet.
• Processing Mode (Select TEST to process in test mode or LIVE to perform Live Transactions)

Enabling logging

The interaction between Magento and CityPay Paylink hosted payment form service may be monitored by enabling the Debug option appearing on the module 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 log file can be found at {root}/var/log/debug.log where root is normally /var/www/html/magento.

Customer Experience

Checkout

• Customer will be presented with the option to pay via CityPay Hosted Payment Form

Paylink Payment Form

• Customer will be presented with the CityPay Paylink Form

Post Processing

• Customer will be redirected back to Magento Store once they hit the Return to Store button

• Customers order summary will mention order status as Processing

• Order details page will display CityPay Payment as the Payment Method

Admin Experience

Orders

• Order will be set to Processing on the Merchant Backend Console and Merchant will have the ability to view that the payment was made by the CityPay Payment Module.