PHPackages                             nicepay/magento-nicepay - 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. nicepay/magento-nicepay

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

nicepay/magento-nicepay
=======================

Nicepay Magento 2 Payment Module

1.0.0(1y ago)01OSL-3.0PHPPHP ~7.4.0||~8.1.0||~8.2.0||~8.3.0||~8.4.0

Since Jun 30Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/nicepay-dev/magento-nicepay)[ Packagist](https://packagist.org/packages/nicepay/magento-nicepay)[ RSS](/packages/nicepay-magento-nicepay/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (6)Versions (3)Used By (0)

NICEPAY Payment Gateway for Magento 2
=====================================

[](#nicepay-payment-gateway-for-magento-2)

NICEPAY ❤️ Magento 2!

Official NICEPAY payment gateway module for Magento 2. This extension enables merchants to accept a wide range of payments securely and efficiently through NICEPAY’s trusted payment APIs.

---

🚀 Features
----------

[](#-features)

- Seamless integration with SNAP and V2 NICEPAY APIs
- Secure transaction handling and logging
- Full support for sandbox (test) and production environments
- Modular payment method support (enable what you need)
- Configuration directly from Magento Admin
- Admin-side payout approval tools
- Built-in support for both SNAP and Non-SNAP notifications

---

💳 Supported Payment Methods
---------------------------

[](#-supported-payment-methods)

### SNAP API

[](#snap-api)

- **Virtual Account** (14+ Indonesian banks)
- **E-Wallet** (Dana, OVO, ShopeePay, LinkAja)
- **QRIS**
- **Payout / Disbursement**

### V2 API

[](#v2-api)

- **Credit/Debit Card**
- **Virtual Account** (same as SNAP)
- **Convenience Store** (Alfa Group, Indomaret)
- **E-Wallet** (Dana, OVO, ShopeePay, LinkAja)
- **Payloan** (Akulaku, Kredivo, Indodana)
- **Payout / Disbursement**
- **QRIS**
- **Redirect to NICEPAY Payment Page**

---

⚙️ Installation
---------------

[](#️-installation)

You can install this Magento 2 module using Composer (recommended) or manually by placing the module in your Magento project.

---

### Method 1: Composer Installation (Recommended)

[](#method-1-composer-installation-recommended)

If your project uses Composer, install the module using:

```
composer require nicepay/magento-libs
```

Then run the Magento setup commands:

```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
```

---

### Method 2: Manual Installation

[](#method-2-manual-installation)

1. Download the module from [GitHub](https://github.com/nicepay-dev/magento-libs).
2. Extract the contents to:

```
app/code/Nicepay/NicePayment

```

3. Add the required Nicepay PHP SDK to your Magento root `composer.json` (if not already added):

```
"require": {
  "nicepay/php-nicepay": "^1.1"
}
```

4. (Optional) If the SDK is not available on Packagist, add the repository definition:

```
"repositories": [
  {
    "type": "vcs",
    "url": "https://github.com/nicepay-dev/php-nicepay"
  }
]
```

5. Then run the following commands:

```
composer update
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
```

---

### Notes

[](#notes)

- For production environments, make sure to clear cache after deployment:

```
php bin/magento cache:clean
php bin/magento cache:flush
```

---

🔧 Configuration
---------------

[](#-configuration)

After installing the module, configure it from:

```
Admin Panel > Stores > Configuration > Sales > Payment Methods > NICEPAY

```

### General Configuration Options

[](#general-configuration-options)

- **Title**: Display name of the payment method
- **Debug Mode**: Enable request/response logs
- **Active**: Enable or disable the method
- **Merchant ID**: From NICEPAY
- **Environment**: `dev` or `prod`
- **API Version**: `v2` or `snap`
- **Merchant Key / Client Secret**: Stored securely
- **Minimum / Maximum Order Amount**: Restrict availability by order value

### Additional Method-Specific Options

[](#additional-method-specific-options)

- **Virtual Account**: Select supported banks
- **QRIS**: `mitra_cd` (partner code), `store_id`
- **Card Payments**: Configure 3DS and secure fields
- **Convenience Store**: Select retailer type (Alfa, Indomaret)

---

💼 Admin Features
----------------

[](#-admin-features)

### Payout Management Interface

[](#payout-management-interface)

A dedicated **Payout Transaction** menu is included in the Magento Admin Panel:

```
Admin Panel > NICEPAY MENU > Payout Transaction

```

This tool enables merchants to:

- ✅ Approve payout requests
- ✅ Reject payout requests
- ✅ Cancel pending payouts

Useful for managing refunds, vendor payments, or custom disbursement logic.

---

🚚 Usage Flow
------------

[](#-usage-flow)

1. Customer selects a NICEPAY payment method during checkout
2. System routes to the appropriate payment experience:
    - **Virtual Account**: Bank transfer instructions shown
    - **Convenience Store**: Convenience store payment instructions shown
    - **E-Wallet**: Redirect to wallet app/web, for ovo you will receive notification on customer OVO app
    - **QRIS**: QR code displayed
    - **Payloan**: Redirect to payloan web/app
    - **Card**: Secure form handled via NICEPAY
3. After the customer completes the payment, Magento receives a server-to-server notification from NICEPAY to update the transaction status automatically. The customer is then redirected back to the store for final confirmation.

---

🔄 Notification &amp; Callback Handling
--------------------------------------

[](#-notification--callback-handling)

The module supports both **SNAP** and **Non-SNAP** notifications. Each category of payment method has a dedicated endpoint.

### Supported Routes

[](#supported-routes)

- **Virtual Account (SNAP)**: `/notification/api/v1.0/transfer-va/payment`
- **QRIS (SNAP)**: `/notification/api/v1.0/qr/qr-mpm-notify`
- **E-Wallet (SNAP)**: `/notification/api/v1.0/debit/notify`
- **Payout (SNAP)**: `/notification/api/v1.0/debit/notify`
- **All Non-Snap PayMethod**: `/nicepay/nicepayment/notification`

These endpoints are automatically routed to their respective controller actions via a custom router class. No extra route configuration is needed on your end.

---

📑 Resources
-----------

[](#-resources)

- [NICEPAY Documentation](https://docs.nicepay.co.id/)
- [Repository](https://github.com/nicepay-dev/magento-nicepay)
- [NICEPAY Dashboard](https://bo.nicepay.co.id/)

---

*Built and maintained with ❤️ by the NICEPAY Team.*

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance52

Moderate activity, may be stable

Popularity1

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 66.7% 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

Unknown

Total

1

Last Release

369d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d059f8f033fa21e1a70ac37cda8f9f02587419f95136babbcaad95580c0d7f82?d=identicon)[nicepayintegration](/maintainers/nicepayintegration)

---

Top Contributors

[![iFazarillah](https://avatars.githubusercontent.com/u/102897548?v=4)](https://github.com/iFazarillah "iFazarillah (4 commits)")[![AbuDhafir](https://avatars.githubusercontent.com/u/107015141?v=4)](https://github.com/AbuDhafir "AbuDhafir (1 commits)")[![nicepay-dev](https://avatars.githubusercontent.com/u/64513674?v=4)](https://github.com/nicepay-dev "nicepay-dev (1 commits)")

### Embed Badge

![Health badge](/badges/nicepay-magento-nicepay/health.svg)

```
[![Health](https://phpackages.com/badges/nicepay-magento-nicepay/health.svg)](https://phpackages.com/packages/nicepay-magento-nicepay)
```

###  Alternatives

[mollie/magento2

Mollie Payment Module for Magento 2

1131.9M16](/packages/mollie-magento2)[buckaroo/magento2

Buckaroo Magento 2 extension

32420.3k8](/packages/buckaroo-magento2)[vipps/module-payment

Vipps MobilePay Payment Module for Magento 2

1098.4k](/packages/vipps-module-payment)[amzn/amazon-pay-magento-2-module

Official Magento2 Plugin to integrate with Amazon Pay

108531.2k1](/packages/amzn-amazon-pay-magento-2-module)[paynl/magento2-plugin

Pay. Payment methods for Magento 2

31329.9k6](/packages/paynl-magento2-plugin)[afterpay-global/module-afterpay

Magento 2 Afterpay Payment Module

26325.8k2](/packages/afterpay-global-module-afterpay)

PHPackages © 2026

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