PHPackages                             techlup/payment-gateway - 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. techlup/payment-gateway

ActiveLibrary[Payment Processing](/categories/payments)

techlup/payment-gateway
=======================

integrate all payment gateways to your project

1.0.5(1y ago)028PHPPHP >7.0

Since Feb 18Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Techlup-Solutions/php-payment-gateway)[ Packagist](https://packagist.org/packages/techlup/payment-gateway)[ RSS](/packages/techlup-payment-gateway/feed)WikiDiscussions main Synced today

READMEChangelogDependenciesVersions (9)Used By (0)

Techlup Pay
===========

[](#techlup-pay)

Php Payment Gateway V 1.0.5
---------------------------

[](#php-payment-gateway-v-105)

Makes it easy to intergrate payment gatway to your php project.

install using composer

> composer require techlup/payment-gateway

M-Pesa intergration
===================

[](#m-pesa-intergration)

configuring the app
-------------------

[](#configuring-the-app)

The following shows the configurations required depending on the API you want to use

```
$config = [
        'CONSUMER_KEY' => '',
        'CONSUMER_SECRET' => '',
        'PASS_KEY' => '', // required for STK push
        'SANDBOX' => true,
    ];
```

make an stk push for buy goods
------------------------------

[](#make-an-stk-push-for-buy-goods)

### initiating the request

[](#initiating-the-request)

first import the dependency to your php class, create an instance of stkpush, then make your request as shown in the code below.

```
// import the dependency
use Techlup\PaymentGateway\Mpesa\StkPush;

// you can use the code below to format user phone number
preg_replace('/^(?:\+?254|0)?/', '254', $request->input("phone"));

$data = new StkPush($config);
$data->setCallbackUrl("{YOUR_API_CALLBACK}") // required
    ->setAmount("{AMOUNT}") // required
    ->setPhone("{PHONE_NUMBER}") // required 254*********
    ->setPartyB('123456')
    ->setShortCode('123456')
    ->setReference("{REF}") //reuired * e.g account number, room number, etc
    ->setRemarks("your remarks"); // optional

$response = $data->tillRequestPush();
```

after the request is submmited, the following response will be ruturned from mpesa.

**Keep in mind that $response is an object of std class**. bellow is an example on how you can access response properties.

to access MerchantRequestID for example `$response->MerchantRequestID`.

```
{
  "MerchantRequestID": "119215-30497********",
  "CheckoutRequestID": "ws_CO_18022023203127******",
  "ResponseCode": "0",
  "ResponseDescription": "Success. Request accepted for processing",
  "CustomerMessage": "Success. Request accepted for processing"
}
```

### accessing the callback.

[](#accessing-the-callback)

on every request you make, m-pesa will make a request to your api url you gave.

I have made it easy for you to access the callback data.

```
// first import the dependencies
use Techlup\PaymentGateway\Mpesa\StkPush;

// get the callback data
$data = StkPush::getCallbackData();
```

below is the format of data returned, **dont forget that it is Std Class, don't confuse with array.**

```
{
  "status": 0,
  "MerchantRequestID": "119215-30497********",
  "CheckoutRequestID": "ws_CO_1802202319494*******",
  "ResultDesc": "The service request is processed successfully.",
  "Amount": 1,
  "MpesaReceiptNumber": "RBI6******",
  "Balance": "Balance",
  "TransactionDate": 20230218194956,
  "PhoneNumber": "254724******"
}
```

Making B2C request
------------------

[](#making-b2c-request)

### Api request

[](#api-request)

reference the daraja api to understad the payload being passed

```
use Techlup\PaymentGateway\Mpesa\B2C;

$data = new B2C($config);
$data->setCallbackUrl("https://enm9smnsyaaq8.x.pipedream.net/")
    ->setAmount(1000)
    ->setOriginatorConversationId($uniqueId = uniqid('', true))
    ->setInitiatorName("username")
    ->setSecurityCredential('password')
    ->setCommandId("BusinessPayment")
    ->setPartyA("paybill")
    ->setPartyB('phone')
    ->setRemarks("here are my remarks")
    ->setOccasion("Testing");

$response = $data->pay();
echo json_encode($response);
```

### Api callback

[](#api-callback)

use the following code to get the result from api callback.

```
$data = Techlup\PaymentGateway\Mpesa\B2C::getCallbackData();
echo json_encode($data);
```

#### Failed request

[](#failed-request)

```
{
  "status": 2001,
  "OriginatorConversationID": "4ad2-40f1-8898-cef301c69e1c20604259",
  "ConversationID": "AG_20240809_*****",
  "ResultDesc": "The initiator information is invalid.",
  "TransactionID": "SH****97H",
  "fails": true
}
```

#### Success request

[](#success-request)

```
{
  "status": 0,
  "OriginatorConversationID": "f0a2-4425-aa4b-1d01d2ea19ea127909458",
  "ConversationID": "AG_20240809_*****",
  "ResultDesc": "The service request is processed successfully.",
  "TransactionID": "SH****PVG",
  "fails": false,
  "TransactionAmount": 1000,
  "TransactionReceipt": "SH96****",
  "ReceiverPartyPublicName": "2547*******75 - D*** ***",
  "TransactionCompletedDateTime": "09.08.2024 15:38:35",
  "B2CUtilityAccountAvailableFunds": 1152.03,
  "B2CWorkingAccountAvailableFunds": 0,
  "B2CRecipientIsRegisteredCustomer": "Y",
  "B2CChargesPaidAccountAvailableFunds": 0
}
```

PayPal integration
==================

[](#paypal-integration)

First you need to configure your env by adding the following.

```
PAYPAL_CLIENT_ID=""
PAYPAL_SECRET=""
```

You can always switch between live and sandbox by updating ` TECHLUP_PAYMENT_SANDBOX=true` to `false`.

Subscription
------------

[](#subscription)

To subscribe users to your system using PayPal follow the steps below.

- import the dependencies

```
use TTechlup\PaymentGateway\Paypal\Subscription;
```

- create the class instance

```
$paypal_subscription = new Subscription(base_path()); // base_path() is the base dir of your application where .env is located;
```

- subscribe the user

```
// define the subscriber
$subscriber = array(
    'name' => array(
        'given_name' => 'John',
        'surname' => 'Doe'
    ),
    'email_address' => 'customer@example.com',
    'shipping_address' => array(
        'name' => array(
            'full_name' => 'John Doe'
        ),
        'address' => array(
            'address_line_1' => '',
            'address_line_2' => '',
            'admin_area_2' => '',
            'admin_area_1' => '',
            'postal_code' => '',
            'country_code' => 'US'
        )
    )
);

// specify your plan
// create the plan on paypal and the the plan id
$plan = new stdClass();
$plan->id = 'P-9PP51961TH493415EMW4NX5A';
$plan->value = '18';

// create the agreement
$agreement = $paypal_subscription->subscribe(
    $plan,
    $subscriber,
    'https://enx316omyr0k.x.pipedream.net/', // return url
    'https://enx316omyr0k.x.pipedream.net/' // cancel url
);
```

Sample response

```
{
  "status": "APPROVAL_PENDING",
  "id": "I-25GFPAT3X2MT",
  "create_time": "2024-01-30T12:21:02Z",
  "links": [
    {
      "href": "https://www.sandbox.paypal.com/webapps/billing/subscriptions?ba_token=BA-0RL61114E6855090G",
      "rel": "approve",
      "method": "GET"
    },
    {
      "href": "https://api.sandbox.paypal.com/v1/billing/subscriptions/I-25GFPAT3X2MT",
      "rel": "edit",
      "method": "PATCH"
    },
    {
      "href": "https://api.sandbox.paypal.com/v1/billing/subscriptions/I-25GFPAT3X2MT",
      "rel": "self",
      "method": "GET"
    }
  ]
}
```

Now direct the user to the approval url. The user will be direct to the return url you provided

- check if subscription was success

```
    $subscriptionDetails = $paypal_subscription->getSubscriptionDetails('SUBSCRIPTION_ID');
    if ($subscriptionDetails['status'] === 'ACTIVE') {
        // Subscription was successfully approved and activated
        // Update database with subscription status
        // For example, update the user's subscription status in the database
    } else {
        // Subscription approval failed or encountered an error
        // Handle the error
        // For example, update the database to mark the subscription as failed
        // And redirect the user to an error page
    }
```

- cancel subscription

```
$paypal_subscription->cancelSubscription('SUBSCRIPTION_ID');
```

###  Health Score

26

—

LowBetter than 41% of packages

Maintenance35

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity46

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

Every ~107 days

Recently: every ~132 days

Total

6

Last Release

693d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/539b4d6340c65da890ad81ee2e6d9853a04ca32fc7a51bad9de5b276a57b8c9d?d=identicon)[techlup](/maintainers/techlup)

---

Top Contributors

[![denisdevke](https://avatars.githubusercontent.com/u/98883557?v=4)](https://github.com/denisdevke "denisdevke (38 commits)")

### Embed Badge

![Health badge](/badges/techlup-payment-gateway/health.svg)

```
[![Health](https://phpackages.com/badges/techlup-payment-gateway/health.svg)](https://phpackages.com/packages/techlup-payment-gateway)
```

###  Alternatives

[msilabs/bkash

bKash Payment Gateway API for Laravel Framework.

181.2k](/packages/msilabs-bkash)

PHPackages © 2026

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