payherokenya/payhero-php

This PHP client library enables easy interaction with the PayHero API, allowing developers to integrate PayHero's payment processing capabilities into their PHP applications. With this client, you can perform operations like checking wallet balances, topping up service wallets, initiating payments,

1.0.1 2024-04-15 17:58 UTC

This package is auto-updated.

Last update: 2024-06-15 18:28:33 UTC


README

PayHeroAPI PHP Client

This PHP client library enables easy interaction with the PayHero API, allowing developers to integrate PayHero's payment processing capabilities into their PHP applications. With this client, you can perform operations like checking wallet balances, topping up service wallets, initiating payments, and querying transaction statuses.

To be able to generate API keys with Pay Hero to use our API services you need to create an account with us. Create an account using below link and verify your account to be able to proceed. Go To: https://app.payhero.co.ke

Features

  • Wallet Balance Inquiry: Check the balance of service and payment wallets.
  • Wallet Top-Up: Top up service wallets with a specified amount.
  • Payment Processing: Send customer M-Pesa STK Push for payment collection.
  • Transaction Status: Check the status of a specific transaction.
  • Account Transactions: Retrieve a list of transactions for an account.
  • SasaPay Payments: Process payments through SasaPay.
  • Withdrawals: Withdraw funds to mobile or bank accounts via SasaPay.

Installation

To get started run this command in your terminal:

composer require payherokenya/payhero-php

To use this PHP client in your project, simply include the PayHeroAPI class in your PHP script.

require_once 'vendor/payherokenya/payhero-php/ph-class.php';

Usage

Initializing the Client

$apiUsername = 'your_api_username';
$apiPassword = 'your_api_password';
$payHeroAPI = new PayHeroAPI($apiUsername, $apiPassword);

Checking Wallet Balances

$serviceWalletBalance = $payHeroAPI->getServiceWalletBalance();
$paymentWalletBalance = $payHeroAPI->getPaymentWalletBalance();

Topping Up Service Wallet

$topUpResponse = $payHeroAPI->topUpServiceWallet($amount, $phone);

Sending Customer M-Pesa STK Push

$stkPushResponse = $payHeroAPI->SendCustomerMpesaStkPush($amount, $phone, $channel_id, $external_reference, $callback_url);

Checking Transaction Status

$transactionStatus = $payHeroAPI->getTransactionStatus($reference);

Get Account Transactions

$accountTransactions = $payHeroAPI->getAccountTransactions($reference);

Processing SasaPay Payments

$sasapayPaymentResponse = $payHeroAPI-> sasaPayPayment($amount,$phone,$network_code,$external_reference,$callback_url);

Making Withdrawals To Mobile

$withdrawalResponse = $payHeroAPI->sasaPayWithdrawToMobile($amount,$phone,$network_code,$external_reference,$callback_url);

Making Withdrawals To Bank

$withdrawalResponse = $payHeroAPI->sasaPayWithdrawToBank($amount,$account_number,$network_code,$external_reference,$callback_url);

Requirements

  • PHP 7.0 or newer
  • cURL support enabled in PHP

Contributing

Contributions to the PayHeroAPI PHP client are welcome. Please ensure that your code adheres to the existing style and that all tests pass.

License

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

Author

Pay Hero Kenya LTD

Maintainers

Version

1.0.1