README

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

Features

The SDK currently supports:

Create payment request
Query transaction status
Verify webhook / callback signature
Refund transaction
Payer authentication for installment payments
Credit card authorization
Capture authorized payment
Reverse authorization
Strong typed request objects
Laravel & Lumen integration
OOP & SOLID compliant architecture

Requirements
Installation
Configuration
PHP Native
Laravel
Lumen
Usage
Initialization
Create Payment
Query Transaction
Verify Webhook
Refund Transaction
Payer Authentication
Authorize Card Payment
Capture Authorized Payment
Reverse Authorization
Enums
License

Requirements

PHP >= 7.4
Required extensions:
json
openssl

Installation

Install via Composer:

composer require ninepay-gateway/rest-client-php

Configuration

PHP Native

use NinePay\Config\NinePayConfig;
use NinePay\Gateways\NinePayGateway;

$config = new NinePayConfig(
    'MERCHANT_ID',
    'SECRET_KEY',
    'CHECKSUM_KEY',
    'SANDBOX' // or PRODUCTION
);

$gateway = new NinePayGateway($config);

You may also create configuration from array:

$config = NinePayConfig::fromArray([
    'merchant_id' => 'MID',
    'secret_key' => 'SECRET',
    'checksum_key' => 'CHECKSUM',
    'env' => 'SANDBOX',
]);

Laravel

Publish configuration file:

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

Then configure environment variables:

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

After configuration, the gateway is automatically resolved via Laravel's service container.

Usage requires only the Facade:

use NinePay\Facades\NinePay;

$response = NinePay::createPayment($request);

Example in controller:

public function pay()
{
    $request = new CreatePaymentRequest(
        'INV_' . time(),
        50000,
        'Payment Order',
        route('payment.return'),
        route('payment.cancel')
    );

    $response = NinePay::createPayment($request);

    return redirect($response->getData()['redirect_url']);
}

Lumen

Copy config file:

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

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

Enable facades:

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

Usage

Initialization

PHP Native:

use NinePay\Config\NinePayConfig;
use NinePay\Gateways\NinePayGateway;

$config = new NinePayConfig('MID', 'SECRET', 'CHECKSUM', 'SANDBOX');
$gateway = new NinePayGateway($config);

Laravel:

$response = NinePay::createPayment($request);

Create Payment

use NinePay\Request\CreatePaymentRequest;
use NinePay\Enums\Currency;
use NinePay\Enums\Language;
use NinePay\Enums\TransactionType;

$request = new CreatePaymentRequest(
    'INV_' . time(),
    3100000,
    'Payment for Order',
    'https://site.com/return',
    'https://site.com/cancel'
);

$request
    ->withClientIp('127.0.0.1')
    ->withCurrency(Currency::VND)
    ->withLang(Language::VI)
    ->withTransactionType(TransactionType::INSTALLMENT)
    ->withExpiresTime(1440);

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

Query Transaction

$response = $gateway->inquiry('INV_123456');

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

Verify Webhook

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

if ($gateway->verify($result, $checksum)) {

    $json = $gateway->decodeResult($result);
    $data = json_decode($json, true);

    $invoiceNo = $data['invoice_no'];
    $status = $data['status'];

    echo 'OK';
} else {
    http_response_code(400);
    echo 'Checksum Mismatch';
}

Refund Transaction

use NinePay\Request\CreateRefundRequest;
use NinePay\Enums\Currency;

$request = new CreateRefundRequest(
    'REF_' . time(),
    436271072913641,
    3100000,
    'Refund reason'
);

$request->withCurrency(Currency::VND)
        ->withBank(
            'BIDV',
            '1023020330000',
            'NGUYEN VAN A'
        );

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

Payer Authentication

use NinePay\Request\PayerAuthRequest;

$request = new PayerAuthRequest(
    'REQ_' . time(),
    5000000,
    'https://site.com/return'
);

$request->withInstallment(5000000, 'VCB', 12)
        ->withCard(
            '4456530000001005',
            'NGUYEN VAN A',
            '12',
            '27',
            '123'
        );

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

Authorize Card Payment

use NinePay\Request\AuthorizeCardPaymentRequest;
use NinePay\Enums\Currency;

$request = new AuthorizeCardPaymentRequest(
    'REQ_' . time(),
    436271072913641,
    3100000,
    Currency::VND
);

$request->withCard(
    '4456530000001005',
    'NGUYEN VAN A',
    '12',
    '27',
    '123'
);

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

Capture Authorized Payment

use NinePay\Request\CapturePaymentRequest;
use NinePay\Enums\Currency;

$request = new CapturePaymentRequest(
    'REQ_' . time(),
    436272499763441,
    20000,
    Currency::VND
);

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

Reverse Authorization

use NinePay\Request\ReverseCardPaymentRequest;

$request = new ReverseCardPaymentRequest(
    'REQ_' . time(),
    436272499763441,
    3100000,
    'VND'
);

$request->withCard(
    '4456530000001005',
    'NGUYEN VAN A',
    '12',
    '27',
    '123'
);

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

Enums

Currency

Supported examples:

VND, USD, EUR, JPY, AUD, ...

Language

VI, EN

Transaction Type

INSTALLMENT
CARD_AUTHORIZATION

ninepay-gateway / rest-client-php

Maintainers

Package info

Statistics

Security