https://github.com/fintech-systems/payfast-onsite-subscriptions
A Payfast Onsite Payments implementation for Laravel designed to ease subscription billing. Livewire views included.
https://github.com/fintech-systems/payfast-onsite-subscriptions
laravel laravel-livewire laravel-nova payfast
Last synced: 2 months ago
JSON representation
A Payfast Onsite Payments implementation for Laravel designed to ease subscription billing. Livewire views included.
- Host: GitHub
- URL: https://github.com/fintech-systems/payfast-onsite-subscriptions
- Owner: fintech-systems
- License: mit
- Created: 2022-06-02T12:54:07.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-11-10T20:32:27.000Z (7 months ago)
- Last Synced: 2025-11-10T22:18:25.253Z (7 months ago)
- Topics: laravel, laravel-livewire, laravel-nova, payfast
- Language: PHP
- Homepage:
- Size: 515 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
## About Payfast Onsite Subscriptions
 
[](https://packagist.org/packages/fintechsystems/payfast-onsite-subscriptions)
A [Payfast Onsite Payments](https://developers.payfast.co.za/docs#onsite_payments) implementation for Laravel designed to ease subscription billing. [Livewire](https://laravel-livewire.com/) views are included.
Requirements:
- PHP 8.3
- Laravel 11.x or higher
- A [Payfast Sandbox account](https://sandbox.payfast.co.za/)
- A [Payfast account](https://www.payfast.co.za/registration)
- Sanctum
If you want to use Laravel Nova, version 4 is required for the `Subscription` and `Receipt` resources.
## Installation
Install the package via composer:
```bash
composer require fintechsystems/payfast-onsite-subscriptions
```
If you don't have Sanctum already:
```bash
php artisan install:api
```
## Publish Configuration and Views
Publish the config file with:
```bash
php artisan vendor:publish --provider="FintechSystems\Payfast\PayfastServiceProvider" --tag="config"
```
Publish the Success and Cancelled views and the Livewire components for subscriptions and receipts.
```bash
php artisan vendor:publish --provider="FintechSystems\Payfast\PayfastServiceProvider" --tag="views"
```
These files are:
```bash
banner.blade.php
billing.blade.php
cancel.blade.php
pricing.blade.php
receipts.blade.php
subscriptions.blade.php
success.blade.php
```
## Setup
Add the `Billable()` trait to your user model.
```php
use FintechSystems\Payfast\Billable;
class User extends Authenticatable
{
/** @use HasFactory<\Database\Factories\UserFactory> */
use HasFactory, Notifiable;
use Billable;
```
## In your header
```php
@if (config('payfast.test_mode'))
@else
@endif
@stack('payfast-event-listener')
```
To include the pricing component on a page, do this:
In your header:
```php
@vite(['resources/css/app.css', 'resources/js/app.js'])
```
In your view:
```php
@include('payfast::components.pricing')
```
### Nova Integration
Optionally publish Laravel Nova Subscription and Receipts Resources and Actions
```bash
php artisan vendor:publish --provider="FintechSystems\Payfast\PayfastServiceProvider" --tag="nova-resources"
```
## Migrations
A migration is needed to create Customers, Orders, Receipts and Subscriptions tables:
```bash
php artisan migrate
```
## Example Configuration
`config/payfast.php`:
```php
env('PAYFAST_MERCHANT_ID'),
'merchant_key' => env('PAYFAST_MERCHANT_KEY'),
'passphrase' => env('PAYFAST_PASSPHRASE'),
'test_mode' => env('PAYFAST_TEST_MODE'),
'test_mode_callback_url' => env('PAYFAST_TEST_MODE_CALLBACK_URL',config('app.url')),
'trial_days' => env('PAYFAST_TRIAL_DAYS', 30),
'merchant_id_test' => env('PAYFAST_MERCHANT_ID_TEST'),
'merchant_key_test' => env('PAYFAST_MERCHANT_KEY_TEST'),
'passphrase_test' => env('PAYFAST_PASSPHRASE_TEST'),
'debug' => env('PAYFAST_DEBUG', false),
'return_url' => env('PAYFAST_RETURN_URL', '/payfast/return'),
'cancel_url' => env('PAYFAST_CANCEL_URL', '/payfast/cancel'),
'notify_url' => env('PAYFAST_NOTIFY_URL', '/payfast/notify'),
'callback_url' => env('PAYFAST_CALLBACK_URL', config('app.url')),
'callback_url_test' => env('PAYFAST_CALLBACK_URL_TEST', ''),
'billables' => [
'user' => [
'model' => User::class,
'trial_days' => 30,
'default_interval' => 'monthly',
'currency_prefix' => 'R ',
'plans' => [
[
'name' => 'Startup',
'short_description' => "",
'monthly' => [
'setup_amount' => 69000,
'recurring_amount' => 69000,
],
'yearly' => [
'setup_amount' => 700000,
'recurring_amount' => 700000,
],
'features' => [
'Feature 1',
'Feature 2',
'Feature 3',
],
'archived' => false,
'cta' => '30 DAY FREE TRIAL',
'mostPopular' => false,
],
[
'name' => 'Business',
'short_description' => "",
'monthly' => [
'setup_amount' => 199000,
'recurring_amount' => 199000,
],
'yearly' => [
'setup_amount' => 2189000,
'recurring_amount' => 2189000,
],
'features' => [
'Feature 1',
'Feature 2',
'Feature 3',
],
'archived' => false,
'cta' => '30 DAY FREE TRIAL',
'mostPopular' => true,
],
],
],
],
];
```
## Livewire setup
### Views
The Livewire views are modelled to blend into a [Laravel Jetstream](https://jetstream.laravel.com) user profile page.
#### Adding a billing menu
In `app.blade.php` below in the Account Management sections (e.g., below profile):
```html
Billing
```
Also look for the responsive part and add this:
```html
Billing
```
#### Adding the subscriptions and receipts views
When calling the Livewire component, you can override any [Payfast form field](https://developers.payfast.co.za/docs#step_1_form_fields) by specifying a `mergeFields` array.
Example modification Jetstream Livewire's `resources/views/profiles/show.php`:
Replace `$user->name` with your first name and last name fields.
```php
@livewire('subscriptions', ['mergeFields' => [
'name_first' => $user->name,
'name_last' => $user->name,
'item_description' => 'Subscription to Online Service'
]] )
@livewire('receipts')
```
## Usage
### Examples
- Generate a payment link
- Create an adhoc token optionally specifying the amount
- Cancel a subscription
- Update a card
```php
use FintechSystems\Payfast\Facades\Payfast;
Route::get('/payment', function() {
return Payfast::payment(5,'Order #1');
});
Route::get('/cancel-subscription', function() {
return Payfast::cancelSubscription('73d2a218-695e-4bb5-9f62-383e53bef68f');
});
Route::get('/create-subscription', function() {
return Payfast::createSubscription(
Carbon::now()->addDay()->format('Y-m-d'),
5, // Amount
6 // Frequency (6 = annual, 3 = monthly)
);
});
Route::get('/create-adhoc-token', function() {
return Payfast::createAdhocToken(5);
});
Route::get('/fetch-subscription', function() {
return Payfast::fetchSubscription('21189d52-12eb-4108-9c0e-53343c7ac692');
});
Route::get('/update-card', function() {
return Payfast::updateCardLink('40ab3194-20f0-4814-8c89-4d2a6b5462ed');
});
```
## Testing
### How to determine when a user's subscription ends
$user->subscription('default')->ends_at = [date in the past]
```bash
composer test
```
In your main project, add this:
```
"repositories": [
{
"type": "path",
"url": "../payfast-onsite-subscriptions"
}
],
```
Then do this to symlink the library:
```
composer require fintechsystems/payfast-onsite-subscriptions:dev-main
```
If you want to test trials, use this one-liner to activate a billable user and a trial using Tinker:
```php
$user = User::find(x)->createAsCustomer(['trial_ends_at' => now()->addDays(30)]);
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Credits
- [Eugene van der Merwe](https://github.com/eugenevdm)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.