PHPackages                             forumpay/magento-2-payment-gateway-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. forumpay/magento-2-payment-gateway-plugin

ActiveMagento2-module[Payment Processing](/categories/payments)

forumpay/magento-2-payment-gateway-plugin
=========================================

ForumPay Crypto Payments for Magento 2

2.1.7(1y ago)0166OSL-3.0PHPPHP &gt;=7.4

Since Aug 4Pushed 1y ago1 watchersCompare

[ Source](https://github.com/forumpay/magento-2-payment-gateway-plugin)[ Packagist](https://packagist.org/packages/forumpay/magento-2-payment-gateway-plugin)[ RSS](/packages/forumpay-magento-2-payment-gateway-plugin/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (5)Versions (10)Used By (0)

ForumPay Crypto Payments for Magento 2
======================================

[](#forumpay-crypto-payments-for-magento-2)

Installation guide
==================

[](#installation-guide)

Requirements
------------

[](#requirements)

> Make sure you have actual version of Magento installed (2.4 and higher).

> Install using the composer

Installation using composer
---------------------------

[](#installation-using-composer)

```
composer require forumpay/magento-2-payment-gateway-plugin
```

### Now you need to use Magento CLI to enable extracted module:

[](#now-you-need-to-use-magento-cli-to-enable-extracted-module)

1. Open command line and navigate to the root of magento installation For example: /var/www/html/magento/
2. Run following commands to activate the module: ```
    php bin/magento module:enable ForumPay_PaymentGateway
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy -f
    php bin/magento cache:flush
    ```

Upgrade from previous version
-----------------------------

[](#upgrade-from-previous-version)

If previous version has been installed manually by unzipping .zip archive, then we need to remove all files from the file system before we install new version using the composer. Locate the **module** directory, usually in to the **/app/code** directory **relative** to your **magento** root. It should look like this: **/app/code/Limitlex/ForumPay**. Remove entire Limitlex folder with all sub-folders and files.

Follow [Installation using composer](#installation-using-composer) section.

When plugin is installed and activate, you need set new webhook url following [How to set up webhook](#how-to-set-up-webhook).

Configuration
-------------

[](#configuration)

Open magento admin panel and go to: **STORES** -&gt; **Configuration** -&gt; **Sales** -&gt; **Payment Methods**

Scroll down until you find ForumPay dropdown. Open it.

Enable module by setting **Enabled** to '**Yes**'.

### What each field does:

[](#what-each-field-does)

1. **Title**The label of the payment method that is displayed when user is prompted to choose one. You can leave default or set it to something like *Pay with crypto*.
2. **Environment**Dropdown lets you switch between 'Production' and 'Sandbox' modes. Use 'Production' for processing real transactions in a live environment and 'Sandbox' for safe testing without financial implications.
3. **API User / Merchant Id**This is our identifier that we need to access the payment system. It can be found in your **Profile**. [Go to profile &gt;](https://dashboard.forumpay.com/pay/userPaymentGateway.api_settings)
4. **API Secret***Important:* never share it to anyone! Think of it as a password. API Secret consists of two parts. When generated in [ForumPay dashboard](https://dashboard.forumpay.com/pay/userPaymentGateway.api_settings), the first one will be displayed in your profile, while the second part will be sent to your e-mail. You need to enter both parts here (one after the other).
5. **POS Id**This is how payments coming to your wallets are going to be identified. Special characters are not allowed. Allowed characters are: `[A-Za-z0-9._-]` (e.g. `my-shop`, `my_shop`).
6. **Accept Instant (Zero) Confirmations**Allows immediate transaction approval without waiting for network confirmations, enhancing speed but with increased risk.
7. **New order status**Which status the order gets when user starts the payment.
8. **Order Status After Payment Captured**Which status the order gets once user successfully completes the payment.
9. **Instructions**Instructions that are going to be displayed for user during the process of placing order.
10. **Sort order**Where the payment method must be placed inside the list of payment methods. 0 = First position, 1 = Second, 2 = Third ...
11. **Payment Icon**Icon that is going to be displayed when we ask user to select payment method.
12. **Custom environment URL**Optional: URL to the API server. This value will override the default setting. Only used for debugging.

Don't forget to hit save button after fields are filled. Magento may also ask you to refresh cache. So if you see something like: '*One or more of the Cache Types are invalidated*', just follow instructions.

Webhook setup
-------------

[](#webhook-setup)

**Webhook** allows us to check order status **independently** of user actions.

For example, if user **closes tab** after payment is started, we cannot determine what the status of order is.

Is it **Cancelled** or is it **Confirmed**? In our case it will be *Pending Payment* **forever**.

### This is where webhook comes in.

[](#this-is-where-webhook-comes-in)

If webhook is set up in your [Profile](https://dashboard.forumpay.com/pay/userPaymentGateway.api_settings#webhook_notifications), it holds the url where it **calls back** on transaction status change.

Now, when user transfers his money and closes the tab before transaction is confirmed (~2 min), we loose state as before.

But now after payment is confirmed, webhook tells our webshop to check order status. And we get proper state of order.

### How to set up webhook

[](#how-to-set-up-webhook)

Go to your [Profile](https://dashboard.forumpay.com/pay/userPaymentGateway.api_settings#webhook_notifications) and scroll down until you find Webhook URL.

Insert **URL** in this field: `YOUR_WEBSHOP/rest/V1/forumpay/webhook`

Where **YOUR\_WEBSHOP** is the URL of your webshop. An example of the complete webhook URL would be: `https://my.webshop.com/rest/V1/forumpay/webhook`

Functionality
-------------

[](#functionality)

Now ForumPay payment method must be available during order checkout.

User has to select **ForumPay** and then choose the cryptocurrency.

When currency is selected, block with transaction data will be displayed. (Amount, Rate, Fee, Total, Expected time).

After currency selection user also has to fill default fields like First/Last Name, County-City-Address-Code and his Phone Number. (These fields are customizable in Magento and aren't related to the plugin).

When user clicks on **Place order** button he is being redirected to the payment view, at this moment transaction is being created and it waits for money transfer.

Then user has 5 minutes to pay the order by scanning the **QR Code** or manually using address shown under the QR Code.

Logging
-------

[](#logging)

Logs live in **/var/log** relative to your magento installation root directory.

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance46

Moderate activity, may be stable

Popularity12

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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 ~76 days

Recently: every ~100 days

Total

9

Last Release

403d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1fd7c036e9ffe08d6af34e9428733f7056cb9d6d18a4503abfb28957ce7ad58b?d=identicon)[forumpay](/maintainers/forumpay)

---

Top Contributors

[![forumpay](https://avatars.githubusercontent.com/u/72375963?v=4)](https://github.com/forumpay "forumpay (9 commits)")

---

Tags

paymentgateway

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/forumpay-magento-2-payment-gateway-plugin/health.svg)

```
[![Health](https://phpackages.com/badges/forumpay-magento-2-payment-gateway-plugin/health.svg)](https://phpackages.com/packages/forumpay-magento-2-payment-gateway-plugin)
```

###  Alternatives

[mollie/magento2

Mollie Payment Module for Magento 2

1121.6M10](/packages/mollie-magento2)[sudiptpa/omnipay-nabtransact

National Australia Bank (NAB) Transact driver for the Omnipay payment processing library.

1017.2k](/packages/sudiptpa-omnipay-nabtransact)[baklysystems/laravel-paymob

Laravel PayMob online payment gateway package

282.4k](/packages/baklysystems-laravel-paymob)[lucassmacedo/omnipay-mercadopago

MercadoPago gateway for OmniPay

154.6k](/packages/lucassmacedo-omnipay-mercadopago)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
