Download the PHP package nicepay/php-nicepay without Composer

PHP - NICEPAY

NICEPAY ❤️PHP!

This is the Official PHP API client/library for NICEPAY Payment API. Visit PHP Library. More information about the product and see documentation at NICEPAY Docs for more technical details.

This library provides access to Nicepay BI SNAP and V2 APIs for backend use.

This library currently supports the following payment methods:

SNAP Version:

• Snap
  • Get Access Token
• Virtual Account:
  • Generate Virtual Account
  • Inquiry Status
  • Cancel
• Ewallet:
  • Payment
  • Inquiry Status
  • Refund
• QRIS:
  • Generate QRIS
  • Inquiry Status
  • Refund
• Payout:
  • Registration
  • Approve
  • Inquiry Status
  • Check Balance
  • Cancel
  • Reject

V2 Version:

• Virtual Account, Convenience Store:
  • Registration
  • Inquiry Status
  • Cancel
• Debit/Credit Card
  • Registration
  • Inquiry Status
  • Cancel
  • Payment

Additional Function

• Helper
  • Verify Signature Sha256

1. Installation

1.1 Manual Install

You can clone or download our source code, then import the folder manually into your project.

1.2 Manual Install with Github link

Add the repository details on your project composer.json

Run composer install if it’s your first time or composer update nicepay/nicepay-php to update that specific package.

1.2 Install with Composer

If you are using Composer, install the library via the Composer CLI:

This will download and install the package, along with its dependencies, into your project. Make sure Composer is properly set up before running this command.

2. Usage

2.1 Client Initialization and Configuration

Get your Credentials from Nicepay Dashboard Initialize Nicepay Config

WARNING: Credentials used here are for testing purposes only.

2.2 Featured services

2.2.1 Snap Version

Snap is Nicepay existing tool to help merchant charge customers using a mobile-friendly, in-page, no-redirect checkout facilities. Using snap is simple.

Available methods for Snap

2.2.1.1 Get Access Token

2.2.1.2 Generate VA

2.2.2 Non-Snap Version (V2)

2.2.2.1 Generate VA

2.2.2.2 Payment Card

The response will contain the HTML content, which should be rendered and processed on your front-end for the 3DS (3D Secure) flow.

Sample HTML Response for 3DS Flow

Here’s an example of the HTML response your front-end should handle. It contains an iframe for 3DS authentication, with the form automatically submitting to the 3DS method URL.

Front-End Integration

1. When the front-end receives the responseHtml, render it as an HTML page.
2. The page will automatically post to the 3DS method URL, redirecting the user to a page where they can enter the OTP sent to their registered device.
3. After completing the 3DS flow, the user is redirected back to your callback URL.

Expected Result :

Once the user completes the 3DS authentication, they will be redirected to your defined callbackUrl, where you can process the result.

2.2.3 Additional Function

Verify Signature Sha256

import :

Code :

3. Examples

Integration test are available

• Virtual Account Sample Functional Test
• E-Wallet Sample Functional Test
• QRIS Sample Functional Test
• Payout Sample Functional Test
• Card Sample Functional Test
• Convenience Store Sample Functional Test
• Inquiry Status Sample Functional Test
• Cancel / Refund Sample Functional Test

Running in Local Development

To run the library in a local environment, follow these steps:

1. Create a .env file in your project root:

   
   APP_ENV=local

2. Load the .env file at the start of your project (e.g., in index.php):

3. Verify the environment variable is set:

By default, if no .env file is loaded, the library will assume it is running in a production environment.

Get help

• Nicepay Docs
• Nicepay Dashboard
• SNAP documentation
• Can't find answer you looking for? email to [email protected]