README

Laravel Pay Pocket

Laravel Pay Pocket is a package designed for Laravel applications, offering the flexibility to manage multiple wallet types within two dedicated database tables, wallets and wallets_logs.

Demo: https://github.com/HPWebdeveloper/demo-pay-pocket

Videos:

Note: This package does not handle payments from payment platforms, but instead offers the concept of virtual money, deposit, and withdrawal.

Author: Hamed Panjeh
Vendor: hpwebdeveloper
Package: laravel-pay-pocket
Alias name: Laravel PPP (Laravel Pay Pocket Package)
Version: 2.x
PHP Version: 8.1+
Laravel Version: 10.x, 11.x
Composer: composer require hpwebdeveloper/laravel-pay-pocket

Support Policy

Installation:

Step 1: You can install the package via composer:

composer require hpwebdeveloper/laravel-pay-pocket

Step 2: Publish and run the migrations with:

php artisan vendor:publish --tag="pay-pocket-migrations"
php artisan migrate

You have successfully added two dedicated database tables, wallets and wallets_logs, without making any modifications to the users table.

Step 3: Publish the wallet types using

php artisan vendor:publish --tag="pay-pocket-wallets"
php artisan vendor:publish --tag="config"

This command will automatically publish the pay-pocket.php config file and also WalletEnums.php file into your application's config and app/Enums directories respectively.

Updating

If updating to version ^2.0.0, new migration and config files have been added to support the new Transaction Notes Feature

Follow the Installation Steps 2 and 3 to update your migrations.

Preparation

Prepare User Model

To use this package you need to implement the WalletOperations into User model and utilize the ManagesWallet trait.

use HPWebdeveloper\LaravelPayPocket\Interfaces\WalletOperations;
use HPWebdeveloper\LaravelPayPocket\Traits\ManagesWallet;

class User extends Authenticatable implements WalletOperations
{
    use ManagesWallet;
}

Prepare Wallets

In Laravel Pay Pocket, you have the flexibility to define the order in which wallets are prioritized for payments through the use of Enums. The order of wallets in the Enum file determines their priority level. The first wallet listed has the highest priority and will be used first for deducting order values.

For example, consider the following wallet types defined in the Enum class (published in step 3 of installation):

namespace App\Enums;

enum WalletEnums: string
{
    case WALLET1 = 'wallet_1';
    case WALLET2 = 'wallet_2';
}

You have complete freedom to name your wallets as per your requirements and even add more wallet types to the Enum list.

In this particular setup, wallet_1 (WALLET1) is given the highest priority. When an order payment is processed, the system will first attempt to use wallet_1 to cover the cost. If wallet_1 does not have sufficient funds, wallet_2 (WALLET2) will be used next.

Example:

If the balance in wallet_1 is 10 and the balance in wallet_2 is 20, and you need to pay an order value of 15, the payment process will first utilize the entire balance of wallet_1. Since wallet_1's balance is insufficient to cover the full amount, the remaining 5 will be deducted from wallet_2. After the payment, wallet_2 will have a remaining balance of 15."

Usage, APIs and Operations:

Deposit

deposit(type: 'wallet_1', amount: 123.45, notes: null)

Deposit funds into wallet_1

$user = auth()->user();
$user->deposit('wallet_1', 123.45);

Deposit funds into wallet_2

$user = auth()->user();
$user->deposit('wallet_2', 67.89);

Or using provided facade

use HPWebdeveloper\LaravelPayPocket\Facades\LaravelPayPocket;

$user = auth()->user();
LaravelPayPocket::deposit($user, 'wallet_1', 123.45);

Note: wallet_1 and wallet_2 must already be defined in the WalletEnums.

Transaction Info (#8)

When you need to add descriptions for a specific transaction, the $notes parameter enables you to provide details explaining the reason behind the transaction.

$user = auth()->user();
$user->deposit('wallet_1', 67.89, 'You ordered pizza.');

Pay

pay(amount: 12.34, notes: null)

Pay the value using the total combined balance available across all allowed wallets

$user = auth()->user();
$user->pay(12.34);

Or using provided facade

use HPWebdeveloper\LaravelPayPocket\Facades\LaravelPayPocket;

$user = auth()->user();
LaravelPayPocket::pay($user, 12.34);

Balance

Wallets

$user->walletBalance // Total combined balance available across all wallets

// Or using provided facade

LaravelPayPocket::checkBalance($user);

Particular Wallet

$user->getWalletBalanceByType('wallet_1') // Balance available in wallet_1
$user->getWalletBalanceByType('wallet_2') // Balance available in wallet_2

// Or using provided facade

LaravelPayPocket::walletBalanceByType($user, 'wallet_1');

Exceptions

Upon examining the src/Exceptions directory within the source code, you will discover a variety of exceptions tailored to address each scenario of invalid entry. Review the demo that accounts for some of the exceptions.

Log

A typical wallets_logs table.

Testing

composer install

composer test


// Or

./vender/bin/pest

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

Hamed Panjeh
All Contributors
Icon in the above image: pocket by Creative Mahira from Noun Project (CC BY 3.0)

License

The MIT License (MIT). Please see License File for more information.

hpwebdeveloper / laravel-pay-pocket

Maintainers

Details