PHPackages citypay/magento-paylink - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Payment Processing](/categories/payments) 4. / 5. citypay/magento-paylink ActiveMagento2-module[Payment Processing](/categories/payments) citypay/magento-paylink ======================= Magento2 plugin for the CityPay Paylink hosted payment page 1.1.8(6mo ago)0821OSL-3.0PHPPHP >=7.3 Since Dec 18Pushed 2mo ago2 watchersCompare [ Source](https://github.com/citypay/citypay-paylink-magento)[ Packagist](https://packagist.org/packages/citypay/magento-paylink)[ RSS](/packages/citypay-magento-paylink/feed)WikiDiscussions master Synced 5d ago READMEChangelog (10)Dependencies (5)Versions (28)Used By (0) [![](https://camo.githubusercontent.com/ac6a0c8b01c7eb6892a4bde8374f42731ba1907d5b8da0c1d8985fc25925f0c2/68747470733a2f2f7777772e636974797061792e636f6d2f77702d636f6e74656e742f75706c6f6164732f323032322f30382f436974797061796c6f676f2d783530302e706e67)](https://camo.githubusercontent.com/ac6a0c8b01c7eb6892a4bde8374f42731ba1907d5b8da0c1d8985fc25925f0c2/68747470733a2f2f7777772e636974797061792e636f6d2f77702d636f6e74656e742f75706c6f6164732f323032322f30382f436974797061796c6f676f2d783530302e706e67) Magento 2 Payment Module ======================== [](#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 ----------------------------------------- [](#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 ------------------ [](#user-documentation) ### Configuring the payment module [](#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** [![plugin_config](https://user-images.githubusercontent.com/28923983/71171425-aab87000-2255-11ea-9d85-d8550f4841c3.png)](https://user-images.githubusercontent.com/28923983/71171425-aab87000-2255-11ea-9d85-d8550f4841c3.png) ### Merchant required settings [](#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 [](#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 ------------------- [](#customer-experience) ### Checkout [](#checkout) - Customer will be presented with the option to pay via CityPay Hosted Payment Form [![checkout](https://user-images.githubusercontent.com/86474060/236212991-a2b591e5-54f4-49a9-9034-43ecf3263de8.png)](https://user-images.githubusercontent.com/86474060/236212991-a2b591e5-54f4-49a9-9034-43ecf3263de8.png) --- ### Paylink Payment Form [](#paylink-payment-form) - Customer will be presented with the CityPay Paylink Form [![paylink_form](https://user-images.githubusercontent.com/86474060/236213523-e4ae5ac1-778f-4f64-a3b8-64d333dbc7ba.png)](https://user-images.githubusercontent.com/86474060/236213523-e4ae5ac1-778f-4f64-a3b8-64d333dbc7ba.png) --- ### Post Processing [](#post-processing) - Customer will be redirected back to Magento Store once they hit the *Return to Store* button [![payment_result](https://user-images.githubusercontent.com/86474060/236214060-c0bfee76-0106-4fea-9700-11ff784397b2.png)](https://user-images.githubusercontent.com/86474060/236214060-c0bfee76-0106-4fea-9700-11ff784397b2.png) --- [![store](https://user-images.githubusercontent.com/86474060/236214778-dc3a47d8-7189-4ee7-bc97-62fcc48f9eb8.png)](https://user-images.githubusercontent.com/86474060/236214778-dc3a47d8-7189-4ee7-bc97-62fcc48f9eb8.png) --- - Customers order summary will mention order status as *Processing* [![customer_orders](https://user-images.githubusercontent.com/86474060/236218888-2af26320-366a-462c-a222-8db1e0b0f093.png)](https://user-images.githubusercontent.com/86474060/236218888-2af26320-366a-462c-a222-8db1e0b0f093.png) --- - Order details page will display CityPay Payment as the Payment Method [![customer_order_details](https://user-images.githubusercontent.com/86474060/236219021-5e119273-243a-4eb6-bf19-f31450400206.png)](https://user-images.githubusercontent.com/86474060/236219021-5e119273-243a-4eb6-bf19-f31450400206.png) --- Admin Experience ---------------- [](#admin-experience) ### Orders [](#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. [![admin_orders](https://user-images.githubusercontent.com/86474060/236219156-2c94a576-9b8e-4bdb-9720-c8af0cf2f3ca.png)](https://user-images.githubusercontent.com/86474060/236219156-2c94a576-9b8e-4bdb-9720-c8af0cf2f3ca.png) --- [![admin_order_info](https://user-images.githubusercontent.com/86474060/236220049-3d1fe0c7-87a3-4dba-93ae-8c63c82702d6.png)](https://user-images.githubusercontent.com/86474060/236220049-3d1fe0c7-87a3-4dba-93ae-8c63c82702d6.png) ### Health Score 43 — FairBetter than 91% of packages Maintenance76 Regular maintenance activity Popularity11 Limited adoption so far Community13 Small or concentrated contributor base Maturity62 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~125 days Recently: every ~218 days Total 17 Last Release 208d ago PHP version history (2 changes)1.0.1PHP 7.\* 1.1.0PHP >=7.3 ### Community Maintainers ![](https://www.gravatar.com/avatar/026115c8e0a5fbe7dd2b1a5f970a07adf87aa4b64c5e88d058952131882fe7dd?d=identicon)[garyfeltham](/maintainers/garyfeltham) --- Top Contributors [![garyfeltham](https://avatars.githubusercontent.com/u/4555938?v=4)](https://github.com/garyfeltham "garyfeltham (49 commits)")[![MichaelM5](https://avatars.githubusercontent.com/u/28923983?v=4)](https://github.com/MichaelM5 "MichaelM5 (40 commits)")[![hectorconceicao](https://avatars.githubusercontent.com/u/86474060?v=4)](https://github.com/hectorconceicao "hectorconceicao (38 commits)")[![martin0](https://avatars.githubusercontent.com/u/2607781?v=4)](https://github.com/martin0 "martin0 (22 commits)") ### Embed Badge ![Health badge](/badges/citypay-magento-paylink/health.svg) ``` [![Health](https://phpackages.com/badges/citypay-magento-paylink/health.svg)](https://phpackages.com/packages/citypay-magento-paylink) ``` ### Alternatives [mollie/magento2 Mollie Payment Module for Magento 2 1121.6M10](/packages/mollie-magento2)[dotdigital/dotdigital-magento2-extension Dotdigital for Magento 2 50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[pagbank/payment-magento PagBank - Payment for Magento and Adobe 2128.3k7](/packages/pagbank-payment-magento) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)