From eeb48ce9938fa9b7308fa0b89d02a206b1050db4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 18 Jul 2023 09:24:16 +0000 Subject: [PATCH 1/3] Version Packages --- .changeset/thirty-weeks-sniff.md | 5 ----- CHANGELOG.md | 6 ++++++ package.json | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) delete mode 100644 .changeset/thirty-weeks-sniff.md diff --git a/.changeset/thirty-weeks-sniff.md b/.changeset/thirty-weeks-sniff.md deleted file mode 100644 index 40a6154..0000000 --- a/.changeset/thirty-weeks-sniff.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"mpesapay": patch ---- - -adding all contributers diff --git a/CHANGELOG.md b/CHANGELOG.md index 530187f..60bef56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # mpesapay +## 4.3.4 + +### Patch Changes + +- c2fc798: adding all contributers + ## 4.3.3 ### Patch Changes diff --git a/package.json b/package.json index f822991..98a7962 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mpesapay", - "version": "4.3.3", + "version": "4.3.4", "description": "A module for processing MPESA payments", "type": "module", "private": false, From fd4d94d9d67f36dea503973b04b820ac3dc0f5fc Mon Sep 17 00:00:00 2001 From: justinelut Date: Tue, 18 Jul 2023 09:36:02 +0000 Subject: [PATCH 2/3] updated the list of contributers --- .changeset/large-dingos-film.md | 5 +++ README.md | 72 ++++++--------------------------- 2 files changed, 18 insertions(+), 59 deletions(-) create mode 100644 .changeset/large-dingos-film.md diff --git a/.changeset/large-dingos-film.md b/.changeset/large-dingos-film.md new file mode 100644 index 0000000..bfc87e9 --- /dev/null +++ b/.changeset/large-dingos-film.md @@ -0,0 +1,5 @@ +--- +"mpesapay": patch +--- + +edited the list of contributers diff --git a/README.md b/README.md index f4b81a4..276cf4c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,4 @@ # Mpesa Pay - -[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-) - - -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) - Mpesa Pay is a JavaScript library that enables developers to easily integrate Mpesa payments into their Node.js, Next.js, SvelteKit, and Nuxt.js applications. It provides an easy-to-use interface for initiating STK Push requests, facilitating Business-to-Business transactions, checking Account Balances, and verifying Transaction statuses. @@ -41,16 +35,13 @@ import MpesaPay from 'mpesapay'; Or use commonjs syntax: ```javascript +const { MpesaPay } = require('mpesapay'); -const { MpesaPay } = require('mpesapay') - -or +or; const MpesaPay = require('mpesapay').default; - ``` - Create an instance of the `MpesaPay` class with your Mpesa API credentials: ```javascript @@ -60,13 +51,11 @@ const Business_Short_Code = 'YOUR_BUSINESS_SHORT_CODE'; const Passkey = 'YOUR_PASS_KEY'; const Transaction_Description = 'YOUR_TRANSACTION_DESCRIPTION'; const Account_Reference = 'YOUR_ACCOUNT_REFERENCE'; -const PartyA = "YOUR_MPESA_PARTYA" -const B2C_Security_Credential = "YOUR MPESA B2C SECURITY CREDENTIAL" -const Initiator_Name = "YOUR MPESA INITIATORS NAME" -const Environment = 'THE ENVIRONMENT i.e sandbox or live' -const Transaction_Type = "YOUR SHORTCODE TYPE i.e paybill or till" - - +const PartyA = 'YOUR_MPESA_PARTYA'; +const B2C_Security_Credential = 'YOUR MPESA B2C SECURITY CREDENTIAL'; +const Initiator_Name = 'YOUR MPESA INITIATORS NAME'; +const Environment = 'THE ENVIRONMENT i.e sandbox or live'; +const Transaction_Type = 'YOUR SHORTCODE TYPE i.e paybill or till'; const mpesapay = new MpesaPay( Consumer_Key, @@ -85,7 +74,7 @@ const mpesapay = new MpesaPay( Replace the placeholders with your actual Mpesa credentials. -> To get your Mpesa credentials, you can follow the procedures outlined in our official documentation available at [Getting Mpesa Credentials](https://mpesapay.verixr.com/getting-started/gettingcredentials). +> To get your Mpesa credentials, you can follow the procedures outlined in our official documentation available at [Getting Mpesa Credentials](https://mpesapay.verixr.com/getting-started/gettingcredentials). **Initiating a Payment** @@ -120,28 +109,28 @@ The `stkPush` method initiates the payment process and returns a Promise. The Pr Make sure to handle the response data and errors accordingly in your application. - ## TypeScript Support The Mpesa Pay module includes TypeScript type definitions, providing enhanced development experience and type checking capabilities when using the library in a TypeScript project. - That's it! You can now integrate Mpesa payments into your Node.js application using the Mpesa Pay library. +> Please note that `stkPush` only initiates payments, and the results will be sent to the provided callback URL. Make sure to implement the necessary server-side logic to handle the payment confirmation notifications and update your database accordingly. -> Please note that ```stkPush``` only initiates payments, and the results will be sent to the provided callback URL. Make sure to implement the necessary server-side logic to handle the payment confirmation notifications and update your database accordingly. +## Contributors ✨ -## Contributors +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): [![All Contributors](https://img.shields.io/github/all-contributors/justinelut/mpesapay?color=ee8449&style=flat-square)](#contributors) + + -
Justine Gichana
Justine Gichana
💻		 Dev_riz
Dev_riz
💻		Justine Gichana
Justine Gichana
💻
@@ -151,16 +140,6 @@ That's it! You can now integrate Mpesa payments into your Node.js application us - - - - - - - - - - [Justine Gichana](https://github.com/justinelut) [Github URL](https://github.com/justinelut/mpesapay) @@ -170,28 +149,3 @@ That's it! You can now integrate Mpesa payments into your Node.js application us [Contributing](https://mpesapay.verixr.com/contributing) [Support Via Paypal](https://www.paypal.com/donate/?hosted_button_id=DYVVE53QU35FS) - - - - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - -
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file From 3b57ee1699302a3b234fb1ae4b89c68a441f8679 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 18 Jul 2023 09:38:25 +0000 Subject: [PATCH 3/3] Version Packages --- .changeset/large-dingos-film.md | 5 ----- CHANGELOG.md | 6 ++++++ package.json | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) delete mode 100644 .changeset/large-dingos-film.md diff --git a/.changeset/large-dingos-film.md b/.changeset/large-dingos-film.md deleted file mode 100644 index bfc87e9..0000000 --- a/.changeset/large-dingos-film.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"mpesapay": patch ---- - -edited the list of contributers diff --git a/CHANGELOG.md b/CHANGELOG.md index 60bef56..95a8654 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # mpesapay +## 4.3.5 + +### Patch Changes + +- fd4d94d: edited the list of contributers + ## 4.3.4 ### Patch Changes diff --git a/package.json b/package.json index 98a7962..cf23cc0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mpesapay", - "version": "4.3.4", + "version": "4.3.5", "description": "A module for processing MPESA payments", "type": "module", "private": false,