PHPackages                             lipad/lipad-sdk - 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. lipad/lipad-sdk

ActiveLibrary[Payment Processing](/categories/payments)

lipad/lipad-sdk
===============

Secure and user-friendly checkout and direct charge API SDK for PHP applications for Lipad Transactions.

v1.0.0(2y ago)06MITPHP

Since Feb 3Pushed 2y ago1 watchersCompare

[ Source](https://github.com/Lipad-Africa-Limited/php-sdk)[ Packagist](https://packagist.org/packages/lipad/lipad-sdk)[ RSS](/packages/lipad-lipad-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Lipad SDK Usage Guide
=====================

[](#lipad-sdk-usage-guide)

Introduction
------------

[](#introduction)

The Lipad SDK for PHP facilitates the integration of Lipad's payment and checkout features into your PHP applications. This comprehensive guide will assist you in the setup and utilization of the Lipad SDK.

Prerequisites
-------------

[](#prerequisites)

Before getting started, ensure you have the following:

- PHP installed on your server or development environment.
- Lipad API credentials, including the IV Key, Consumer Secret, Consumer Key.

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

[](#installation)

1. **Download the Lipad SDK:**Download the Lipad SDK and include it in your project.

    ```
    # Example using Composer
    composer require lipad/lipad-sdk
    ```
2. **Include the Composer autoloader in your PHP file:**

    ```
    require_once 'vendor/autoload.php';
    ```
3. **Instantiate the Lipad class with your credentials:**

    ```
    use Lipad\LipadSdk\Lipad;

    // Replace these values with your actual credentials
    $IVKey = 'your_iv_key';
    $consumerSecret = 'your_consumer_secret';
    $environment = 'sandbox';
    ```

Checkout Usage
--------------

[](#checkout-usage)

1. **To initialize the Lipad class, provide the $IVKey, $consumerKey, $consumerSecret, and $environment parameters. The $environment should be one of the following: 'production' or 'sandbox'.**

    ```
    $lipad = new Lipad($IVKey, $consumerKey, $consumerSecret, $environment);
    ```
2. **Validate Payload**

    ```
    try {
    $lipad->validateCheckoutPayload($payload);
    } catch (Exception $error) {
    echo 'Error: ' . $error->getMessage() . "\n";
    }
    ```
3. **Encrypt Payload**

    ```
    $encryptedPayload = $lipad->encrypt($payload);
    ```
4. **Get Checkout Status**

    ```
    try {
    $lipad->getCheckoutStatus($payload["merchant_transaction_id"]);
    } catch (Exception $error) {
    echo 'Error: ' . $error->getMessage() . "\n";
    }
    ```
5. **Build Checkout URL**

    ```
    try {
        $checkoutUrl =
        'https://checkout2.dev.lipad.io/?access_key=' .
        urlencode($accessKey) .
        '&payload=' .
        urlencode($encryptedPayload);
         echo 'Checkout URL: ' . $checkoutUrl . "\n";
       } catch (Exception $error) {
         echo 'Error: ' . $error->getMessage() . "\n";
       }
    ```

Direct API Usage
----------------

[](#direct-api-usage)

1. **To initialize the Lipad class, provide the $IVKey, $consumerSecret, and $environment parameters. The $environment should be one of the following: 'production' or 'sandbox'.**

    ```
    $lipad = new Lipad($IVKey, $consumerSecret, $environment);
    ```
2. **Direct Charge**

    ```
    try {
    $lipad->DirectCharge($payload);
    } catch (Exception $error) {
     echo 'Error: ' . $error->getMessage() . "\n";
    }
    ```
3. **Get Charge Request Status**

    ```
    try {
    $lipad->getChargeRequestStatus($chargeRequestId);
    } catch (Exception $error) {
    echo 'Error: ' . $error->getMessage() . PHP_EOL;
    }
    ```

License
=======

[](#license)

This SDK is open-source and available under the MIT License.
------------------------------------------------------------

[](#this-sdk-is-open-source-and-available-under-the-mit-license)

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 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

Unknown

Total

1

Last Release

829d ago

### Community

Maintainers

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

---

Top Contributors

[![mbuthiawaweru-lipad](https://avatars.githubusercontent.com/u/205767544?v=4)](https://github.com/mbuthiawaweru-lipad "mbuthiawaweru-lipad (1 commits)")

### Embed Badge

![Health badge](/badges/lipad-lipad-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/lipad-lipad-sdk/health.svg)](https://phpackages.com/packages/lipad-lipad-sdk)
```

###  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)