pstk/paystack-magento2-module

Paystack Magento 2 Module

Paystack payment gateway Magento2 extension

Version: 3.0.10 (Paystack v2 Inline.js API)

Requirements

• Magento 2.4.x
• PHP 8.2+

Installation

Composer (Recommended)

Go to your Magento2 root folder and run:

composer require pstk/paystack-magento2-module
php bin/magento module:enable Pstk_Paystack
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

Manual Installation

Copy all files to app/code/Pstk/Paystack/ in your Magento installation, then run:

php bin/magento module:enable Pstk_Paystack
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

Configuration

To configure the plugin in Magento Admin:

1. Go to Stores > Configuration > Sales > Payment Methods.
2. Find Paystack and configure:
   • Enabled: Yes/No
   • Title: What customers see at checkout
   • Integration Type: Inline (Popup) or Redirect
   • Test Mode: Enable for sandbox testing
   • Test/Live Secret Key: Get from your Paystack dashboard
   • Test/Live Public Key: Get from your Paystack dashboard
3. Click Save Config.

Webhook Setup

For reliable payment confirmation (especially for the redirect flow), set up a webhook in your Paystack dashboard:

1. Go to Settings > API Keys & Webhooks on your Paystack dashboard
2. Set the Webhook URL to: https://yourdomain.com/paystack/payment/webhook
3. The module handles charge.success events and automatically updates order status

Development Environment

A Docker-based development environment is included in the dev/ directory for contributors and testing.

Prerequisites

• Docker (or Rancher Desktop with dockerd runtime)
• A Paystack test account

Quick Start

cd dev
cp .env.example .env     # Add your Paystack test keys
docker compose up -d      # First run builds the image (~5 min) and installs Magento (~3 min)
bash setup.sh             # Enables module, creates test products, configures everything

Once complete you'll see:

============================================
  Setup complete!

  Storefront:  http://localhost:8080
  Admin panel: http://localhost:8080/admin
  Admin login: admin / Admin12345!

  Test card:   4084 0840 8408 4081
  Expiry:      12/30
  CVV:         408
  PIN:         0000
  OTP:         123456
============================================

What's Included

• Magento 2.4.8-p3 via Mage-OS public mirror (no Adobe marketplace auth needed)
• OpenSearch 2.19.1 + MariaDB 10.6
• 5 test products with images and a configured homepage
• Paystack payment pre-configured in test mode (inline popup)
• Container names: paystack-magento, paystack-db, paystack-search

Tear Down

cd dev
docker compose down        # Stop containers (preserves data)
docker compose down -v     # Stop containers and delete all data

Documentation

• Paystack Documentation
• Paystack Helpdesk

Support

For bug reports and feature requests directly related to this plugin, please use the issue tracker.

For general support or questions about your Paystack account, you can reach out by sending a message from our website.

Community

If you are a developer, please join our Developer Community on Slack.

Contributing to the Magento 2 plugin

If you have a patch or have stumbled upon an issue with the Magento 2 plugin, you can contribute this back to the code. Please read our contributor guidelines for more information how you can do this.

Changelog

All notable changes to the Paystack Magento 2 module are documented here.
This project adheres to Semantic Versioning.

The entries below cover every release since the last tag, v3.0.4.

[3.0.10] - 2026-07-17

Consolidated release for Magento 2.4.9 / PHP 8.5, verified end-to-end with
Content-Security-Policy enforced.

Fixed

• Payment verification failed on PHP 8.5 even when the payment succeeded.
  Gateway/PaystackApiClient.php called curl_close(), which is deprecated in
  PHP 8.5 (a no-op since PHP 8.0). Magento escalates the deprecation to an
  exception, and it fired after the charge was confirmed — so customers saw
  "Payment verification failed" despite a successful payment. Removed all
  curl_close() calls (the handle is freed automatically).
• Admin order creation on Adobe Commerce (EE). The payment method now
  implements MethodInterface directly instead of extending AbstractMethod,
  and getInfoInstance() matches the expected contract, preventing EE-only
  interceptors from crashing admin pages. Adds a defence-in-depth admin-area guard.

Added

• PHPUnit unit-test suite (Test/Unit/**, phpunit.xml) covering the payment
  model, controllers, gateway client, observers, config provider, and plugins.
• End-to-end test coverage and a dedicated admin-config MFTF page object/section.

[3.0.9] - 2026-07-17

Superseded by 3.0.10 (its fixes are included there).

Fixed

• Checkout page hung on the loading spinner under enforced CSP. The module's
  PHP CSP PolicyCollector replaced Magento's entire Content-Security-Policy,
  dropping 'self' from script-src and blocking Magento's own JavaScript on the
  checkout page (CSP is enforced by default on checkout/payment pages since 2.4.7).
  Replaced with the standard, additive etc/csp_whitelist.xml mechanism.
• MFTF PaystackPaymentConfigAvailableTest 404'd in the Adobe pipeline. The
  test navigated with a raw amOnPage url="admin/..." that resolved to
  /admin/admin/.... Switched to an area="admin" page object (emits a correct
  base-relative URL) and core AdminLoginActionGroup/AdminLogoutActionGroup.

[3.0.8] - 2026-06-22

Added

• Storefront guest-checkout MFTF coverage (StorefrontPaystackCheckoutRendersTest)
  guarding against the "checkout does not load" class of failure.

Changed

• Hardened the Adobe Marketplace build script so internal artifacts are excluded
  from the published zip.

[3.0.7] - 2026-04-07

Changed

• Version bump (no functional changes).

[3.0.6] - 2026-04-07

Changed

• Reworked the checkout method-renderer JavaScript to lazy-load the Paystack Inline
  SDK, so a slow/blocked SDK no longer stalls checkout rendering.
• Updated ConfigProvider and the payment model.

Added

• First vendor MFTF test (PaystackPaymentConfigAvailableTest) verifying the
  payment method appears in admin configuration.
• Empty etc/adminhtml/di.xml to keep the module out of the admin DI scope.

[3.0.5] - 2026-03-06

Fixed

• Admin order-create crash on Adobe Commerce (EE). Scoped the
  PaymentManagementInterface preference to frontend/webapi_rest (removed from
  the global/admin scope) and lazy-loaded the payment method, so admin order
  creation and MFTF tests are no longer affected by frontend-only dependencies.

Note: 3.0.5–3.0.10 were not individually tagged; see the commit history since
v3.0.4 for details.