F57/laravel-viva-wallet

Viva Wallet's API for Laravel applications

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation steps

1. install the package via composer:

composer require deyjandi/laravel-viva-wallet

2. Publish the config file with:

php artisan vendor:publish --tag="viva-wallet-config"

3. Add at minimum the following to the .env file

VIVA_WALLET_MERCHANT_ID=<your-merchant-id>
VIVA_WALLET_API_KEY=<your-api-id>
VIVA_WALLET_CLIENT_ID=<your-smart-checkout-client-id>
VIVA_WALLET_CLIENT_SECRET=<your-smart-checkout-secret>

You can refer to the ./config/viva-wallet-config.php for additional configuration options

Usage

Create a Payment Order using the default configuration:

...

use Deyjandi\VivaWallet\Facades\VivaWallet;
use Deyjandi\VivaWallet\Payment;

...

$payment = new Payment($amount = 1000);

$checkoutUrl = VivaWallet::createPaymentOrder($payment);

...

Create a Payment Order specifying every configurable option:

...

use Deyjandi\VivaWallet\Enums\RequestLang;
use Deyjandi\VivaWallet\Enums\PaymentMethod;
use Deyjandi\VivaWallet\Facades\VivaWallet;
use Deyjandi\VivaWallet\Customer;
use Deyjandi\VivaWallet\Payment;

...

$customer = new Customer(
    $email = 'example@test.com',
    $fullName = 'John Doe',
    $phone = '+306987654321',
    $countryCode = 'GR',
    $requestLang = RequestLang::Greek,
);

$payment = new Payment();

$payment
    ->setAmount(2500)
    ->setCustomerTrns('short description of the items/services being purchased')
    ->setCustomer($customer)
    ->setPaymentTimeout(3600)
    ->setPreauth(false)
    ->setAllowRecurring(true)
    ->setMaxInstallments(3)
    ->setPaymentNotification(true)
    ->setTipAmount(250)
    ->setDisableExactAmount(false)
    ->setDisableCash(true)
    ->setDisableWallet(false)
    ->setSourceCode(1234)
    ->setMerchantTrns('customer order reference number')
    ->setTags(['tag-1', 'tag-2'])
    ->setBrandColor('009688')
    ->setPreselectedPaymentMethod(PaymentMethod::PayPal);

$checkoutUrl = VivaWallet::createPaymentOrder($payment);

...

Retrieve transaction:

...

use Deyjandi\VivaWallet\Facades\VivaWallet;

...

$transaction = VivaWallet::retrieveTransaction($transactionId);

Request a webhook verification key:

php artisan viva-wallet:webhook-key

the webhook verification key is stored to the .env file automatically

Testing

composer 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

• Pavlos Kafritsas

License

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