Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eugenefvdm/payfast-onsite-subscriptions
A Payfast Onsite Payments implementation for Laravel designed to ease subscription billing. Livewire views included.
https://github.com/eugenefvdm/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/eugenefvdm/payfast-onsite-subscriptions
- Owner: eugenefvdm
- License: mit
- Created: 2022-06-02T12:54:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T22:39:17.000Z (3 months ago)
- Last Synced: 2024-10-10T12:42:00.058Z (3 months ago)
- Topics: laravel, laravel-livewire, laravel-nova, payfast
- Language: PHP
- Homepage:
- Size: 623 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.backup.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
 
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.1
- Laravel 9.x or higher
- A [Payfast Sandbox account](https://sandbox.payfast.co.za/)
- A [Payfast account](https://www.payfast.co.za/registration)
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 fintech-systems/payfast-onsite-subscriptions
```
## 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
```
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')
```
You'll end up with a page looking like this:
### 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', '10004002'),
'merchant_key' => env('PAYFAST_MERCHANT_KEY', 'q1cd2rdny4a53'),
'passphrase' => env('PAYFAST_PASSPHRASE', 'payfast'),
'test_mode' => env('PAYFAST_TEST_MODE', true),
'return_url' => env('PAYFAST_RETURN_URL', config('app.url') . '/payfast/return'),
'cancel_url' => env('PAYFAST_CANCEL_URL', config('app.url') . '/payfast/cancel'),
'notify_url' => env('PAYFAST_NOTIFY_URL', config('app.url') . '/payfast/notify'),
'card_update_link_css' => env('CARD_UPDATE_LINK_CSS', 'inline-flex items-center px-4 py-2 bg-gray-800 border border-transparent rounded-md font-semibold text-xs text-white uppercase tracking-widest hover:bg-gray-700 active:bg-gray-900 focus:outline-none focus:border-gray-900 focus:ring focus:ring-gray-300 disabled:opacity-25 transition'),
'card_updated_return_url' => env('CARD_UPDATED_RETURN_URL', config('app.url') . '/user/profile'),
'plans' => [
3 => [
'name' => 'Monthly R 99',
'start_date' => \Carbon\Carbon::now()->addDay()->format('Y-m-d'),
'payfast_frequency' => 3,
'initial_amount' => 5.99,
'recurring_amount' => 5.99,
],
6 => [
'name' => 'Yearly R 1089',
'start_date' => \Carbon\Carbon::now()->format('Y-m-d'),
'payfast_frequency' => 6,
'initial_amount' => 6.89,
'recurring_amount' => 6.89,
]
],
'cancelation_reasons' => [
'Too expensive',
'Lacks features',
'Not what I expected',
],
];
```
## 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
vendor/bin/phpunit
```
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)]);
```
To see if a user is on trial as used in the subscriptions blade, do this:
```php
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Screenshots
## Credits
- [Eugene van der Merwe](https://github.com/eugenevdm)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.