README

"Pitaka" is a term commonly used in the Philippines that translates to "wallet" in English.

Easy creation of Wallets and its transactions.

 $wallet = $user->wallets()->create([
        'name' => 'Peso Wallet',
        'slug' => 'peso-wallet',
        'raw_balance' => 0,
        'decimal_places' => 2,
        'metadata' => [
            'Currency' => 'PHP',
        ],
    ]);
    
    
    $wallet->deposit(1000.58);

Installation

You can install the package via composer:

composer require marjose123/pitaka
composer dump-autoload

You can publish and run the migrations with:

php artisan vendor:publish --tag="pitaka-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="pitaka-config"

This is the contents of the published config file:

return [
 /**
     * --------------------------------------------------------------
     *  Wallet Migration
     * --------------------------------------------------------------
     * This will be used for the Wallet Table.
     */
    'wallet_table' => [
        'default_decimal_places' => 2,
    ],

    /**
     *  -------------------------------------------------------------------
     *  Default User Wallet
     *  -------------------------------------------------------------------
     */
    'user' => [
        'wallet' => null, // Add your default wallet name here. This will be used if you don't provide a wallet name when calling `$user->wallet()`
    ],
];

Usage

You can do a transaction in your wallet by using user relationship or through model class.

Caution

Changing your wallet decimal_places value may affect your wallet balance result.

Wallet balance check against Transaction amount

Check if the wallet balance is enough to do a transaction

$user->wallet('peso-wallet')->check(500) // will return true/false depending on how much amount left in the wallet

$product = Product::find(1);
$user->wallet('peso-wallet')->check($product)

Implement WalletTransaction contract to your Product class.

Wallet Deposit Transaction

Creating a wallet transaction by depositing an amount. You can also use the Wallet model class instead.

 $wallet = $user->wallets()->create([
        'name' => 'Peso Wallet',
        'slug' => 'peso-wallet',
        'raw_balance' => 0,
        'decimal_places' => 2,
        'metadata' => [
            'Currency' => 'PHP',
        ],
    ]);
    
    
    $wallet->deposit(1000.58);

Wallet Pay

Creating a wallet transaction by paying an item/shop amount using your wallet.

$user->wallet('peso-wallet')->pay(500);

$product = Product::find(1);
$user->wallet('peso-wallet')->pay($product);

Wallet Deduction/Withdraw

You can deduct or do a withdrawal from the wallet with/out fee.

 $wallet->withdraw(amount: 900, feeAmount: 100);

  $wallet->withdraw(1000);

Transfer money to other wallet

You can transfer money to other wallets.

$wallet1->transfer(amount: 50, wallet: $wallet2, feeAmount: 50);

$wallet1->transfer(amount: 50, wallet: $wallet2);

Retrieve Wallet Balance

$user->wallet('peso-wallet')->balance;

Return wallet balance in decimal format.

$user->wallet('peso-wallet')->balance_float;

Testing

composer package:test

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

License

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

marjose123 / pitaka

Maintainers

Details