Skip to content

Commit 45fca6b

Browse files
committed
Checkpoint: documentation checkpoint
1 parent aae38a4 commit 45fca6b

File tree

12 files changed

+637
-3
lines changed

12 files changed

+637
-3
lines changed

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
All notable changes to `laravel-mpesa` will be documented in this file.
44

5-
## 1.0.0 - 2020-07-01
5+
## 1.0.0 - 2025-01-20
66

7-
- Initial release
7+
- Initial release of the package 🎉, documentation included
8+
- Added support for Laravel 6, 7, 8, 9, 10, 11
9+
- Added support for PHP 7.4, 8.0, 8.1, 8.2, 8.3, 8.4
10+
- Added support for Mpesa API v1, v2
11+
- Added support for Mpesa B2C, B2B, C2B, STK Push, Reversal, Account Balance, Transaction Status, Lipa Na Mpesa Online Payment

docs/Auth/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Auth
3+
weight: 1
4+
---

docs/Auth/introduction.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Initiating Mpesa API
3+
weight: 1
4+
---
5+
6+
## Creating an authentication token
7+
8+
We assume that you have already installed the package and have the necessary credentials from Safaricom. If you don't have the credentials, you can get them by registering on the [Safaricom Developer Portal](https://developer.safaricom.co.ke/).
9+
10+
To create an authentication token, you need to call the `generateToken` method from the `Mpesa` facade. The method returns an array with the token and the expiry time.
11+
12+
```php
13+
use Ghost\LaravelMpesa\Facades\Mpes
14+
15+
$token = Mpesa::generateToken();
16+
```

docs/C2B/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: C2B API
3+
weight: 1
4+
---

docs/C2B/introduction.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Initiating C2B API
3+
weight: 1
4+
---
5+
6+
## What is B2C API?
7+
8+
The B2C API is used to make payments from a Business to Customers (B2C). This is the most common API used by businesses to make payments to customers. The API is used to make payments to customers who have registered with the business.
9+
10+
This API includes the following features:
11+
12+
1. **Payment Request**: This is the request that is sent to the customer to make a payment. The request includes the amount to be paid, the customer's phone number, and the business's account number.
13+
2. **Payment Confirmation**: This is the confirmation that the payment has been made. The confirmation includes the amount paid, the customer's phone number, and the business's account number.

docs/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: v1
3+
slogan: Laravel Mpesa package
4+
githubUrl: https://github.com/ghostscypher/laravel-mpesa
5+
branch: main
6+
---

docs/changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Changelog
3+
weight: 6
4+
---
5+
6+
All notable changes to laravel-event-sourcing are documented [on GitHub](https://github.com/ghostscypher/laravel-mpesa/blob/main/CHANGELOG.md)

0 commit comments

Comments
 (0)