xenon/portwallet-php-sdk

PortWallet payment gateway PHP SDK for APIv2

1.0.1-alpha 2022-08-08 18:27 UTC

Requires

• php: ^7.2|^7.3|^7.4|8.*
• ext-json: *
• justinrainbow/json-schema: ^5.2
• symfony/http-client: ^5.1

apache-2.0

• Sujan Mahmud
• Zohurul Islam
• Ariful Islam

README

I am just forking and added support for several php versions

Installation

composer require xenon/portwallet-php-sdk

Usage

This guideline will follow PortWallet Payment GateWay v2.0

$portWallet = new \Xenon\PortWallet\PortWalletClient($apiKey, $apiSecret);

Create an invoice

Here, $data is the order payload which is an array

Sample data example

use Xenon\PortWallet\Exceptions\PortWalletClientException;
use Xenon\PortWallet\PortWallet;
use Xenon\PortWallet\PortWalletClient; 

/**
 * 
 * $appKey: application key you have to 
 * generate form our sandbox panel
 * 
 * $apiSecret: application secret key 
 * you have to generate form 
 * our sandbox panel
 * 
 */
$apiKey = "your app key";
$apiSecret = "your secret key";

/**
 * mode switching default "sandbox"
 */
PortWallet::setApiMode("live");

N.B.: API mode should be set first before creating an instance of PortWalletClient

/**
 * initiate the PortWallet client
 */
$portWallet = new PortWalletClient($apiKey, $apiSecret);

/**
 * Your data
 */
$data = array(
    'order' => array(
        'amount' => 100.0,
        'currency' => 'BDT',
        'redirect_url' => 'http://www.yoursite.com/payment',
        'ipn_url' => 'http://www.yoursite.com/ipn',
        'reference' => 'ABC123',
        'validity' => 900,
    ),
    'product' => array(
        'name' => 'x Polo T-shirt',
        'description' => 'x Polo T-shirt with shipping and handling',
    ),
    'billing' => array(
        'customer' => array(
            'name' => 'Robbie Amell',
            'email' => '[e-mail]',
            'phone' => '801234567893',
            'address' => array(
                'street' => 'House 1, Road1, Gulshan 1',
                'city' => 'Dhaka',
                'state' => 'Dhaka',
                'zipcode' => 1212,
                'country' => 'BGD',
            ),
        ),
    ),
    'discount' => array(
        'enable' => 1,
        'codes' => array(
            0 => 'Bengal 1',
            1 => 'Bengal 2',
        ),
    ),
    'emi' => [
        'enable' => 1,
        'tenures' => [],
    ]
);

try {
    $invoice = $portWallet->invoice->create($data);
    $paymentUrl = $invoice->getPaymentUrl();
} catch (InvalidArgumentException $ex) {
    echo $ex->getMessage();
}catch (PortWalletException $ex) {
    echo $ex->getMessage();
}

header("location: {$paymentUrl}");

IPN validate

// we will send you a http post request to your IPN url
$invoiceId = $_POST['invoice'];
$amount = $_POST['amount'];

$invoice = $portWallet->invoice->ipnValidate($invoiceId, $amount);

Make a refund request

$data = array (
    'refund' =>
        array (
            'amount' => 50.00,
            'reference'=>'Refund1010'
        ),
    );

$response = $portPay->invoice->makeRefundRequest($invoiceId, $data);

Retrieve an invoice

$invoice = $portWallet->invoice->retrieve($invoiceId); // $invoiceId = 85ED8B0D14611209

PortWallet\Invoice {#304 ▼
  +invoice_id: "85ED8B0D14611209"
  +reference: "ABC123"
  +order: {#296 ▶}
  +product: {#292 ▶}
  +billing: {#297 ▶}
  +shipping: {#300 ▶}
  +customs: array:3 [▶]
}

Create a recurring

$data = array (
       'order' =>
           array (
               'amount' => 100.0,
               'currency' => 'BDT',
               'redirect_url' => 'http://www.yoursite.com',
               'ipn_url' => 'http://www.yoursite.com/ipn',
               'reference' => 'ABC123',
           ),
       'product' =>
           array (
               'name' => 'Order #17339988',
               'description' => 'Bangobd Membership Individual (7-day trial: BDT 5) After trail period monthly BDT 100',
           ),
       'billing' =>
           array (
               'customer' =>
                   array (
                       'name' => 'John Doe Recurr',
                       'email' => '[e-mail]',
                       'phone' => '01717451349',
                       'address' =>
                           array (
                               'street' => 'House 1, Road1, Gulshan 1',
                               'city' => 'Dhaka',
                               'state' => 'Dhaka',
                               'zipcode' => 1212,
                               'country' => 'BGD',
                           ),
                   ),
               'source' =>
                   array (
                       'id' => '8d4fd2',
                       'category' => 'card',
                   ),
           ),
       'shipping' =>
           array (
               'customer' =>
                   array (
                       'name' => 'Mr. Recurr',
                       'email' => '[e-mail]',
                       'phone' => '01717451349',
                       'address' =>
                           array (
                               'street' => 'House 1, Road1, Gulshan 1',
                               'city' => 'Dhaka',
                               'state' => 'Dhaka',
                               'zipcode' => 1212,
                               'country' => 'BGD',
                           ),
                   ),
           ),
       'recurring' =>
           array (
               'period' =>
                   array (
                       'unit' => 'monthly',
                       'prorated' => true,
                   ),
               'number_of_payment' => 6,
           ),
       );

$invoice = $portPay->recurring->create($data);

Retrieve a recurring

$recurring = $portWallet->recurring->retrieve($invoiceId); // $invoiceId = 85EDC82FE2900875

PortWallet\Recurring {#301 ▼
  +id: "R85EDC82FE2900875"
  +status: "PENDING"
  +name: "Order #17339988"
  +description: "Bangobd Membership Individual (7-day trial: BDT 5) After trail period monthly BDT 100"
  +period: {#294 ▶}
  +has_trial: false
  +trial: {#296 ▶}
  +has_offers: false
  +offers: {#287 ▶}
  +is_prorated: true
  +payment: {#292 ▶}
  +started: "Sun, 07 Jun 2020 12:02:38 +0600"
  +ended_at: "Mon, 30 Nov 2020 23:59:59 +0600"
  +next_payment: {#291 ▶}
  +customer: {#295 ▶}
  +user_id: 0
  +source: {#297 ▶}
  +history: array:1 [▶]
}