laravel-billplz
, (*1)
Laravel-billplz is a simple service providers and generator to connect your laravel powered app to Billplz api v3., (*2)
Before you getting started, kindly visit https://www.billplz.com/enterprise/signup to register an acount and read https://www.billplz.com/api#v3 for better understanding., (*3)
Install
Require this package with composer using the following command:, (*4)
``` bash
composer require cyvelnet/laravel-billplz, (*5)
After updating and installed, add the service provider to the `providers` array in `config/app.php` file
```php
Cyvelnet\LaravelBillplz\LaravelBillplzServiceProvider::class
And finally add the facade to the aliases array section in config/app.php, (*6)
Cyvelnet\LaravelBillplz\Facades\Billplz::class
How to use
Bills api
Create a bill
To create a billplz bill
\Billplz::issue(function (Cyvelnet\LaravelBillplz\Messages\BillMessage $bill)
{
// bill with a amount RM50
$bill->to('name', 'email', 'mobile')
->amount(50) // will multiply with 100 automatically, so a RM500 bill, you just pass 500 instead of 50000
->callbackUrl('http://foorbar.com/foo/bar/webhook/')
->description('description');
});
An UnacceptableRequestException will be throw for any call with any missing parameter., (*7)
Alternatively, you may generate reusable bill with artisan command php artisan make:bill MonthlyManagementBill, (*8)
\Billplz::send(new MonthlyManagementBill())
->to('foobar')
->viaEmail('foo@bar.com') // you may use viaSms('mobile no') or viaEmailAndSms('email', 'mobile no')
To delete an existing bill
$request = \Billplz::delete('bill_id');
if($request->isSuccess())
{
// perform after deletion operation
}
To retrieves a bill
$bill = \Billplz::get('bill_id')->toArray();
A BillNotFoundException will be throw for any missing bill., (*9)
Collections api
To create a collection
$request = \Billplz::collection('collection title');
if($request->isSuccess())
{
$collection = $request->toArray() // you can call getRawBillplzResponse(false) to get response in POPO
}
to customize your collection more, pass in an anonymous function as the second parameter, (*10)
$request = \Billplz::collection('collection title', function (\Cyvelnet\LaravelBillplz\Messages\CollectionMessage $collection) {
// split a payment by RM50
$collection->logo(storage_path('/billplz/my-logo.jpg'))
->splitPaymentByFixed('foo@bar.com', 50) // will convert into 5000 cents automatically
});
To create an open collection with fixed amount
// create a open collection with a fixed amount RM500
$request = \Billplz::openCollection('collection title', 'collection description', 500);
if($request->isSuccess())
{
$collection = $request->toArray() // you can call getRawBillplzResponse(false) to get response in POPO
}
To create an open collection with any amount and any quantity pass a closure as third parameter
// create a open collection with a fixed amount RM500
$request = \Billplz::openCollection('collection title', 'collection description', function (\Cyvelnet\LaravelBillplz\Messages\OpenCollectionMessage $collection) {
$collection->anyAmountAndQty();
// ->splitPaymentByVariable('foo@bar.com', 50); // split payment by 50%
// ->tax(6) // 6% tax
// ->photo(storage_path('/billplz/my-photo.jpg'))
// ->reference1('your references')
});
if($request->isSuccess())
{
$collection = $request->toArray() // you can call getRawBillplzResponse(false) to get response in POPO
}
Sandbox
Billplz api v3, enabled sandbox functionality where developers are allowed to isolates api request to a sandbox and trigger payment completion on demand., (*11)
By default sandbox is disabled, to enable sandbox mode add a BILLPLZ_ENABLE_SANDBOX = true entry to .env and ensure you have proper configured api_key and collection_id for both production and sandbox., (*12)
Wallogit.com
cyvelnet