niranjan94/payumoney

PayUMoney library for PHP

1.1 2016-10-05 16:26 UTC

This package is auto-updated.

Last update: 2024-11-09 22:48:08 UTC


README

StyleCI

PayUMoney API for PHP

Simple library for accepting payments via PayUMoney.

Installation

To add this library to your project, simply add a dependency on niranjan94/payumoney to your project's composer.json file. Here is a minimal example of a composer.json file:

{
    "require": {
        "niranjan94/payumoney": "1.*"
    }
}

Usage

You'll find a minimal usage example below.

Initialize purchase

<?php
// purchase.php

use CodeZero\PayUMoney\PayUMoney;

require 'vendor/autoload.php';

$payumoney = new PayUMoney([
    'merchantId' => 'YOUR_MERCHANT_ID',
    'secretKey'  => 'YOUR_SECRET_KEY',
    'testMode'   => true
]);

// All of these parameters are required!
$params = [
    'txnid'       => 'A_UNIQUE_TRANSACTION_ID',
    'amount'      => 10.50,
    'productinfo' => 'A book',
    'firstname'   => 'Peter',
    'email'       => 'abc@example.com',
    'phone'       => '1234567890',
    'surl'        => 'http://localhost/payumoney-php/return.php',
    'furl'        => 'http://localhost/payumoney-php/return.php',
];

// Redirects to PayUMoney
$payumoney->initializePurchase($params)->send();

Finalize purchase

<?php
// return.php

use CodeZero\PayUMoney\PayUMoney;
use CodeZero\PayUMoney\PurchaseResult;

require 'vendor/autoload.php';

$payumoney = new PayUMoney([
    'merchantId' => 'YOUR_MERCHANT_ID',
    'secretKey'  => 'YOUR_SECRET_KEY',
    'testMode'   => true
]);

$result = $payumoney->completePurchase($_POST);

if ($result->checksumIsValid() && $result->getStatus() === PurchaseResult::STATUS_COMPLETED) {
  print 'Payment was successful.';
} else {
  print 'Payment was not successful.';
}

The PurchaseResult has a few more methods that might be useful:

$result = $payumoney->completePurchase($_POST);

// Returns Complete, Pending, Failed or Tampered
$result->getStatus(); 

// Returns an array of all the parameters of the transaction
$result->getParams();

// Returns the ID of the transaction
$result->getTransactionId();

// Returns true if the checksum is correct
$result->checksumIsValid();