README

A modern Shopware 6 payment plugin that integrates Paystack, enabling merchants across Africa to accept secure online payments via multiple channels.

Developed with ❤️ by Kommandhub Limited

Table of Contents

• Features

• Supported Payment Channels

• Requirements

• Installation

  • Via Composer
  • Manual Installation

• Configuration

• Payment Flow

• Development & Testing

• Compatibility

• Troubleshooting

• Support

• License

Features

• Seamless integration with Shopware 6 checkout
• Secure Paystack hosted payment page
• Automatic order transaction status updates
• Built-in sandbox mode for testing
• Optional debug logging for troubleshooting
• Stores Paystack transaction references and metadata
• Clean and native Shopware payment method integration

Supported Payment Channels

Depending on your Paystack configuration:

• Debit & Credit Cards
• Bank Transfers
• USSD
• QR Codes
• Mobile Money (Ghana, Kenya, etc.)

Requirements

• Shopware: ~6.6.0 or ~6.7.0
• PHP: ^8.2
• Paystack Account: https://dashboard.paystack.com/#/signup
• Composer

Installation

Via Composer (Recommended)

composer require kommandhub/paystack-sw
bin/console plugin:refresh
bin/console plugin:install --activate KommandhubPaystackSW
bin/console cache:clear

Manual Installation (GitHub Upload)

1. Download ZIP from your repository

2. Ensure correct structure:

   KommandhubPaystackSW.zip
   ├── src/
   ├── composer.json
   

3. Upload via:

   Administration → Extensions → My Extensions → Upload Extension

4. Install and activate plugin

Configuration

Navigate to:

Administration → Extensions → My Extensions → Paystack → Configuration

Live Mode

• Enter Live Secret Key (sk_live_...)

Sandbox Mode

• Enable sandbox
• Enter Test Secret Key (sk_test_...)

Debugging

Enable logging to write detailed logs to:

var/log/

Recommended for troubleshooting.

Activate Payment Method

1. Go to:

   Settings → Shop → Payment Methods
   

2. Enable Paystack Payment

3. Assign it to your Sales Channel

Payment Flow

Customer selects Paystack
        ↓
Redirect to Paystack Checkout
        ↓
Customer completes payment
        ↓
Redirect back to Shopware
        ↓
Plugin verifies transaction
        ↓
Order marked as Paid

Development & Testing

To ensure a consistent environment, tests and development tools should be run inside the plugin's Docker container.

1. Start the Container

make up

2. Enter the Container Shell

make shell

3. Run Development Commands

Once inside the container, you can execute the following commands:

Run Tests

make test

Test Coverage

make test-coverage

Static Analysis (PHPStan)

make analyse

Code Style (PHP-CS-Fixer)

make cs
make cs-fix

Compatibility

Troubleshooting

Payment not updating?

• Ensure webhook/verification flow is working
• Check logs in var/log/
• Confirm correct API keys (test vs live)

Plugin not visible?

bin/console plugin:refresh

Cache issues?

bin/console cache:clear

Support

For support:

• Email: admin@kommandhub.com
• Website: https://kommandhub.com

License

This project is licensed under the MIT License. See the LICENSE file for details.