README

Official PHP SDK for integrating 9PAY Payment Gateway.
Supports PHP Native, Laravel, and Lumen.

This package allows you to:

Create payment requests
Query transaction status
Verify webhook / callback data
Integrate easily using OOP, SOLID & Facade pattern

Requirements
Installation
Configuration
- PHP Native
- Laravel
- Lumen
Usage
Error Handling
Testing
Security
License

Requirements

PHP >= 7.4
Extensions:
- json
- openssl

Installation

Install the SDK via Composer:

composer require ninepay-gateway/rest-client-php

Configuration

PHP Native

$config = [
    'merchant_id'  => 'YOUR_MERCHANT_ID',
    'secret_key'   => 'YOUR_SECRET_KEY',
    'checksum_key' => 'YOUR_CHECKSUM_KEY',
    'env'          => 'SANDBOX',
];

Laravel

php artisan vendor:publish --tag=ninepay-config

NINEPAY_MERCHANT_ID=your_merchant_id
NINEPAY_SECRET_KEY=your_secret_key
NINEPAY_CHECKSUM_KEY=your_checksum_key
NINEPAY_ENV=SANDBOX

Lumen

mkdir -p config
cp vendor/ninepay-gateway/rest-client-php/config/ninepay.php config/ninepay.php

$app->register(NinePay\NinePayServiceProvider::class);
$app->configure('ninepay');

$app->withFacades();
class_alias(NinePay\Facades\NinePay::class, 'NinePay');

Usage

Initialization

use NinePay\PaymentManager;

$manager = new PaymentManager($config);
$gateway = $manager->getGateway();

use NinePay;

$gateway = NinePay::getGateway();

Create Payment

use NinePay\Support\CreatePaymentRequest;

$request = new CreatePaymentRequest(
    'INV123456',
    '50000',
    'Payment for order #123',
    'https://your-site.com/callback',
    'https://your-site.com/return'
);

$response = $gateway->createPayment($request);

if ($response->isSuccess()) {
    header('Location: ' . $response->getData()['redirect_url']);
    exit;
}

echo $response->getMessage();

Query Transaction

$response = $gateway->inquiry('9PAY_TRANSACTION_ID');

if ($response->isSuccess()) {
    print_r($response->getData());
}

Verify Webhook / Callback

$result = $_POST['result'] ?? '';
$checksum = $_POST['checksum'] ?? '';

if ($gateway->verify($result, $checksum)) {
    $decoded = $gateway->decodeResult($result);
    $data = json_decode($decoded, true);
} else {
    http_response_code(400);
}

Error Handling

use NinePay\Exceptions\PaymentException;

try {
    $gateway->createPayment($request);
} catch (PaymentException $e) {
    logger()->error($e->getMessage());
}

Testing

composer test

Security

Please report security issues to hotro@9pay.vn.

ninepay-gateway / rest-client-php

Maintainers

Details