npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

payhero-wrapper

v1.0.21

Published

Here's the updated README with the Pesapal integration:

Downloads

27

Readme

Here's the updated README with the Pesapal integration:

Unofficial PayHero Node.js SDK

Welcome to the unofficial PayHero Node.js SDK, this SDK provides a convenient way to integrate PayHero and Pesapal payment functionality into your Node.js applications.

Installation

You can install the PayHero Node.js SDK via npm:

npm i payhero-wrapper

Usage

First, import the PayHero class:

import PayHero from 'payhero-wrapper';

Then, initialize PayHero with your API keys:

const PayHeroConfig = {
  Authorization: 'your_PayHero_authorization_token',
  pesapalConsumerKey: 'your_pesapal_consumer_key',
  pesapalConsumerSecret: 'your_pesapal_consumer_secret',
  pesapalApiUrl: 'https://payments.pesapal.com/pesapalv3/api', // Sandbox or production URL
  pesapalCallbackUrl: 'https://your-application.com/pesapal-callback',
  pesapalIpnId: 'your_pesapal_ipn_id'
};

const PayHero = new PayHero(PayHeroConfig);

Making STK Push Payments

const paymentDetails = {
    amount: 10,
    phone_number: "0740161331",
    channel_id: 333,
    provider: "m-pesa",
    external_reference: "INV-009",
    callback_url: "https://example.com/callback.php"
};

PayHero.makeStkPush(paymentDetails)
    .then(response => console.log(response))
    .catch(error => console.error(error));

Initiating Pesapal Payments

const pesapalPaymentDetails = {
    currency: 'KES',
    amount: 1000,
    description: 'Test payment',
    customerEmail: '[email protected]',
    customerFirstName: 'John',
    customerLastName: 'Doe',
    phoneNumber: '0712345678',
    countryCode: 'KE'
};

const { orderTrackingId, merchantReference, redirectUrl } = await PayHero.initiatePesapalPayment(pesapalPaymentDetails);
console.log('Pesapal payment initiated:');
console.log('Order Tracking ID:', orderTrackingId);
console.log('Merchant Reference:', merchantReference);
console.log('Redirect URL:', redirectUrl);

// Redirect the user to the Pesapal payment page
you can use the redirectUrl to open it on your app or give users to open and make the payment;

Verifying Pesapal Transactions

const paymentStatus = await PayHero.verifyPesapalTransaction('your_order_tracking_id');
console.log('Pesapal transaction status:', paymentStatus);

Retrieving Payment Channels, Banks, Wallet Balances, Transactions, and more

The SDK provides the following additional functions:

  • paymentChannels()
  • createPaymentChannel(channelDetails)
  • getBanks()
  • serviceWalletBalance()
  • paymentsWalletBalance()
  • topUpServiceWallet(topUpDetails)
  • accountTransactions()
  • transactionStatus(transactionId)
  • withdraw(withdrawalDetails)
  • makeWhatsappPayment(whatsappDetails)

Please refer to the code examples in the previous section for usage.

Configuration

To use the PayHero Node.js SDK, you need to initialize it with your PayHero and Pesapal API keys:

const PayHeroConfig = {
  Authorization: 'your_PayHero_authorization_token',
  pesapalConsumerKey: 'your_pesapal_consumer_key',
  pesapalConsumerSecret: 'your_pesapal_consumer_secret',
  pesapalApiUrl: 'https://payments.pesapal.com/pesapalv3/api', // Sandbox or production URL
  pesapalCallbackUrl: 'https://your-application.com/pesapal-callback',
  pesapalIpnId: 'your_pesapal_ipn_id'
};

const PayHero = new PayHero(PayHeroConfig);

Issues and Contributions

If you encounter any issues with the SDK or have suggestions for improvements, feel free to open an issue on GitHub.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.