PHPackages publicsquare-financial/magento-payments-plugin - 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. publicsquare-financial/magento-payments-plugin ActiveComposer-plugin[Payment Processing](/categories/payments) publicsquare-financial/magento-payments-plugin ============================================== The Magento plugin provides a one-click install into PublicSquare's payment gateway for credit and debit card processing. v0.2.1(3mo ago)002[2 PRs](https://github.com/publicsquare-financial/publicsquare-magento-payments-plugin/pulls)PHPCI failing Since Oct 22Pushed 3mo ago3 watchersCompare [ Source](https://github.com/publicsquare-financial/publicsquare-magento-payments-plugin)[ Packagist](https://packagist.org/packages/publicsquare-financial/magento-payments-plugin)[ RSS](/packages/publicsquare-financial-magento-payments-plugin/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (8)Versions (40)Used By (0) PublicSquare Financial ====================== [](#publicsquare-financial) PublicSquare provides a software platform for retailers to access third-party providers for lease-to-own financing and other lending products based on a consumer's credit profile. INSTALLATION ------------ [](#installation) ### Manual Installation [](#manual-installation) - extract files from an archive - deploy files into Magento2 folder `app/code/` ### Enabled Extension [](#enabled-extension) - enable extension (in command line, see manual: `http://devdocs.magento.com/guides/v2.0/config-guide/cli/config-cli-subcommands.html`): > `$> bin/magento module:enable PublicSquare_Payments` - to make sure that the enabled module is properly registered, run 'setup:upgrade': > `$> bin/magento setup:upgrade` - \[if needed\] re-deploy static view files: > `$> bin/magento setup:static-content:deploy` ### Webhook Configuration [](#webhook-configuration) **Automated Configuration** - \[after v0.2.0 upgrade\] ``` bin/magento psq:configure-webhook bin/magento cache:flush ``` **Manual Configuration** 1. In the \[[https://portal.publicsquare.com\](PublicSquare](https://portal.publicsquare.com](PublicSquare) Portal) create a new webhook under **Developer > Webhook** with the following properties: - URL: `{magento.hostname}/publicsquare-payments/webhook/index` - Event Types: - refund:update - settlement:update 2. Enter the Webhook ID and Webhook Key in to the Magento Admin panel under: **Stores > Configuration > Sales > Payment Methods > PublicSquare** ### Docker Installation [](#docker-installation) If you need a local installation of Magento2, the cleanest way is to use Docker. [This repo](https://github.com/markshust/docker-magento?tab=readme-ov-file#automated-setup-new-project) provides an out of the box installation with just a few commands. - Make sure docker engine is running - One-liner to install Magento ``` $ curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/onelinesetup | bash -s -- magento.test 2.4.7 community ``` *Replace `2.4.7` with the version of Magento you want to install.* *Replace `magento.test` with the local domain you want to use.* - Open ([https://magento.test)\[https://magento.test\]](https://magento.test)%5Bhttps://magento.test%5D) to confirm installation ``` $ open https://magento.test ``` - Seed sample data ``` $ bin/magento sampledata:deploy $ bin/magento setup:upgrade ``` ### Local environment using this repo (Docker + sample data) [](#local-environment-using-this-repo-docker--sample-data) This repository also includes a self-contained Docker setup and helper scripts to provision a full local environment (containers, Magento, this plugin, and sample data). 1. **Start / provision the IT stack (first time or after reset)** ``` # Will bring up containers, install Magento, deploy static content, # configure PublicSquare keys, and install Magento sample data. make it-complete-build ``` - If you don't pass any arguments, `it-install` (called under the hood) will **prompt for your PublicSquare PUBLIC and SECRET keys**. - In CI or when scripting, you can pass the keys explicitly: ``` make it-complete-build ``` 2. **Subsequent runs** - To restart the stack without reinstalling Magento: ``` make it-down make it-up ``` - To tear everything down and reset volumes: ``` make it-reset ``` ### Deploying plugin changes in the IT/local environment [](#deploying-plugin-changes-in-the-itlocal-environment) When you change this plugin's code and want Magento to pick up the changes (DI, static content, etc.) inside the IT Docker stack, use: ``` make deploy ``` This runs `bin/deploy` inside the `web` container, which will: - Run `composer install` inside the container - Enable maintenance mode - Clear generated code and preprocessed view files - Run `bin/magento setup:upgrade` - Recompile DI (`bin/magento setup:di:compile`) - Redeploy static content (`bin/magento setup:static-content:deploy en_US -f`) - Disable maintenance mode and flush caches Use this after code changes to ensure Magento is fully rebuilt and serving updated assets. ### Automated tests [](#automated-tests) #### Running acceptance tests locally [](#running-acceptance-tests-locally) ``` composer install php vendor/bin/codecept run Acceptance --steps ``` #### Running integration/acceptance tests against the IT stack [](#running-integrationacceptance-tests-against-the-it-stack) Once your IT environment is up (for example via `make it-complete-build`), you can execute the full Codeception test suite wired for the Docker stack with: ``` make it-test ``` To run codecept with detail breakdown of steps and debugging add these flags: ``` ./vendor/bin/codecept run tests/Acceptance/ --steps --debug ``` using the configuration in `codeception.yml` and `tests/Acceptance.suite.yml`, against `http://magento.test` via Selenium/WebDriver. ### Health Score 35 — LowBetter than 79% of packages Maintenance79 Regular maintenance activity Popularity2 Limited adoption so far Community16 Small or concentrated contributor base Maturity41 Maturing project, gaining track record 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 ~13 days Total 35 Last Release 111d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/6e8feaa82d00d51a3e2dc810f1030d5475eea4d2dbf2a37815fe67bdc1408d35?d=identicon)[rlfrahmpsq](/maintainers/rlfrahmpsq) --- Top Contributors [![rlfrahm](https://avatars.githubusercontent.com/u/5338740?v=4)](https://github.com/rlfrahm "rlfrahm (48 commits)")[![jamesjonescredova](https://avatars.githubusercontent.com/u/210400705?v=4)](https://github.com/jamesjonescredova "jamesjonescredova (45 commits)")[![abrahambosch](https://avatars.githubusercontent.com/u/811013?v=4)](https://github.com/abrahambosch "abrahambosch (11 commits)")[![btilfordpubsq](https://avatars.githubusercontent.com/u/214548783?v=4)](https://github.com/btilfordpubsq "btilfordpubsq (6 commits)")[![bweber](https://avatars.githubusercontent.com/u/603733?v=4)](https://github.com/bweber "bweber (1 commits)")[![jaybeckr](https://avatars.githubusercontent.com/u/20869477?v=4)](https://github.com/jaybeckr "jaybeckr (1 commits)")[![kraken-chris](https://avatars.githubusercontent.com/u/116098137?v=4)](https://github.com/kraken-chris "kraken-chris (1 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/publicsquare-financial-magento-payments-plugin/health.svg) ``` [![Health](https://phpackages.com/badges/publicsquare-financial-magento-payments-plugin/health.svg)](https://phpackages.com/packages/publicsquare-financial-magento-payments-plugin) ``` ### Alternatives [omnipay/paypal PayPal gateway for Omnipay payment processing library 3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto Biblioteca com boletos para o laravel 626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money. 1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php 2Checkout PHP Library 83740.3k2](/packages/2checkout-2checkout-php)[smhg/sepa-qr-data Generate QR code data for SEPA payments 61717.2k5](/packages/smhg-sepa-qr-data)[omnipay/dummy Dummy driver for the Omnipay payment processing library 271.2M33](/packages/omnipay-dummy) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)