PHPackages                             berzel/paynow-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. berzel/paynow-php

ActiveLibrary[Payment Processing](/categories/payments)

berzel/paynow-php
=================

PHP library for Paynow (Zimbabwes leading online payments platform)

v1.1.0(7y ago)71082GPL-3.0-or-laterPHP

Since Aug 18Pushed 7y ago3 watchersCompare

[ Source](https://github.com/Berzel/paynow-php)[ Packagist](https://packagist.org/packages/berzel/paynow-php)[ RSS](/packages/berzel-paynow-php/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

Paynow-Php
----------

[](#paynow-php)

A simple Paynow library (implementation using PHP) which provides an expressive and fluent interface to the Paynow payments

gateway. It handles pretty much all of the boilerplate code you dreading writing.

Installation
------------

[](#installation)

Install the package through [Composer](http://getcomposer.org/).

Run the Composer require command from the Terminal:

```
composer require berzel/paynow-php

```

If you're using Laravel 5.5 or later, this is all there is to do.

Should you still be on version 5.4 of Laravel, the final steps for you are to add the service provider of the package and

alias the package. To do this open your `config/app.php` file.

Add a new line to the `providers` array:

```
Berzel\Paynow\PaynowServiceProvider::class

```

And optionally add a new line to the `aliases` array:

```
'Paynow' => Berzel\Paynow\Facades\Paynow::class,

```

Now you're ready to start using the library in your application. Please note that this is not an official liabrary from

Paynow.

Overview
--------

[](#overview)

Look at one of the following topics to learn more about this library

- [Usage](#usage)
- [Example](#example)

Usage
-----

[](#usage)

This library gives you the following methods to use:

### Paynow::getInstance()

[](#paynowgetinstance)

Getting/Creating an instance of the paynow class is really simple, you just use the `getInstance()` method, which accepts

two parameters. In its most basic form you just specify the id and key of your paynow integration. You can retrieve your Paynow

app id and app key from the Paynow control panel.

```
$paynow = Paynow::getInstance($appId, $appKey);
```

**The `getInstance()` method will return a Berzel\\Paynow\\Paynow instance.**

### Paynow::initiateTransaction()

[](#paynowinitiatetransaction)

Paynow expects you to supply a certain number of values when initiating a transaction. These values are

```
- returnurl => the url (on your website) that the user will be redirected to after completing a transaction on paynow
- resulturl => the url (on your website) that paynow will post order updates to
- amount => the amount that you wish to charge the user
- reference => the order reference number/string
- info => additional information about the order
- status => the status of the order
- email => the email address to associate with this order

```

The `initiateTransaction()` method will attempt to initiate a transaction on the paynow platform, and it accepts a

PaynowOrder instance which you can create using the `createOrder()` method (documented below). The `initiateTransaction()`

method will throw an Exception if the attempt to initiate a transaction fails. If the request was successful the full Paynow

response array will be returned from the method. The array will contain a 'browserurl' key value which you can use to

redirect the user to Paynow to complete the payment. The 'pollurl' key value contains the url on paynow that you can use in

future to get status updates about the order (You should save this to you local storage engine for future use). Other keys

that are contained in the result array are the 'status', 'hash', etc, of which you are encouraged to also save to your local

storage for future use.

```
$fields = [$resultUrl, $returnUrl, $amount, $reference, $info, $status, $email];

$order = $paynow->createOrder($fields);

$result = $paynow->initiateTransaction($order);
```

If an error occurs you can catch the exception and use the `getMessage()` method to get information about why the

transaction failed to initiate.

### Paynow::createOrder()

[](#paynowcreateorder)

To create a paynow order instance use the `createOrder()` method, which retains an instance of the PaynowOrder class which

is to be passed as an argument to the `initiateTransaction()` method. The method accepts an array as an argument which

should contain the details of your order. This array should contain these keys resulturl, returnurl, amount, reference, info,

status, and email. All fields are required and if any of the keys is not found the method will throw an exception.

```
$fields = [
    'resulturl' => $resUrl,
    'returnurl' => $retUrl,
    'amount' => $amt,
    'reference' => $ref,
    'info' => $info,
    'status' => $status,
    'email' => $email
];

$order = $paynow->createOrder($fields);
```

### Paynow::returnFromPaynow and Paynow::updateFromPaynow

[](#paynowreturnfrompaynow-and-paynowupdatefrompaynow)

When you are returning from paynow after the user has completed payment. You can call the `returnFromPaynow()` or

`updateFromPaynow()` method. This method throws an exception if anything unexpected happens when requesting the Paynow

platform for updates. If everything goes well it will return the current/latest status(Paid, Cancelled, Awaiting Delivery,

etc) of the order on paynow. Both methods accept an argument which is the poll url returned earlier when trying to initiate

a transaction.

```
$orderStatus = $paynow->returnFromPaynow($order->pollUrl);
```

Example
-------

[](#example)

Initiating a transaction on paynow
==================================

[](#initiating-a-transaction-on-paynow)

```
use Berzel\Paynow\Paynow;

public function checkout($cart)
{
    // lets grab the id and key and initUrl from config
    $id = config('paynow.id');
    $key = config('paynow.key');

    //begin a database transaction
    $this->db->beginTransaction();

    //create a new order
    $order = $this->user()->createOrder($cart);

    //order details. Please note I am using laravel's route helper function here but any valid url will do
    $fields = [
        'resulturl' => route('order.result', $order->getId()),
        'returnurl' => route('order.return', $order->getId()),
        'amount' => $order->getTotal(),
        'reference' => $order->getReference(),
        'info' => $order->getAdditionalInfo(),
        'status' => $order->getCurrentStatus(),
        'email' => $order->user()->getEmail()
    ];

    try {
        //create/get a new paynow instance
        $paynow = Paynow::getInstance($id, $key);

        // initiate a transaction on paynow
        $result = $paynow->initiateTransaction($paynow->createOrder($fields));

        // before redirecting the user to paynow lets save the results to local db
        $order->setStatus($result['status']);

        $order->setPaynowPollUrl($result['pollurl']);

        $order->save();

        // commit database changes
        $this->db->commit();

        // redirect the user to paynow
        return redirect()->url($result['browserurl']);

    } catch (Exception $e) {
        // rollback database changes
        $this->db->rollBack();

        $err = $e->getMessage();
    }
}
```

When returning from paynow
==========================

[](#when-returning-from-paynow)

```
public function getFromPaynow(Order $order)
{
    try {
        $orderStatus = Paynow::getInstance($id, $key)->returnFromPaynow($order->getPollUrl());

        // show the user that the order status

    } catch (Exception $e) {
        // show the user the error that occured
    }
}
```

When just getting an update from paynow
=======================================

[](#when-just-getting-an-update-from-paynow)

```
// this could be where you are showing the user his/her order details
public function show(Order $order)
{
    try {
        $orderStatus = Paynow::getInstance($id, $key)->updateFromPaynow($order->pollUrl);

        // show the user the user the status
    } catch (Exception $e) {
        // show the user the error message
    }
}
```

**For now that will be all.**

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

3

Last Release

2818d ago

Major Versions

v0.1 → v1.0.02018-08-20

### Community

Maintainers

![](https://www.gravatar.com/avatar/bd035ab109095866199a55b2c756f699afea8a5b674aa50e027ac7c8f2a24763?d=identicon)[Berzel](/maintainers/Berzel)

---

Top Contributors

[![berzel](https://avatars.githubusercontent.com/u/15382703?v=4)](https://github.com/berzel "berzel (25 commits)")

### Embed Badge

![Health badge](/badges/berzel-paynow-php/health.svg)

```
[![Health](https://phpackages.com/badges/berzel-paynow-php/health.svg)](https://phpackages.com/packages/berzel-paynow-php)
```

###  Alternatives

[omnipay/paypal

PayPal gateway for Omnipay payment processing library

3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto

Biblioteca com boletos para o laravel

626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle

This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money.

1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php

2Checkout PHP Library

83740.3k2](/packages/2checkout-2checkout-php)[smhg/sepa-qr-data

Generate QR code data for SEPA payments

61717.2k5](/packages/smhg-sepa-qr-data)[omnipay/dummy

Dummy driver for the Omnipay payment processing library

271.2M33](/packages/omnipay-dummy)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)