Subiendo proyecto completo sin restricciones de git ignore
This commit is contained in:
Jose Sanchez
64
vendor/kingflamez/laravelrave/docs/getting-started/installation.md
vendored
Normal file
64
vendor/kingflamez/laravelrave/docs/getting-started/installation.md
vendored
Normal file
@@ -0,0 +1,64 @@
|
||||
# Installation
|
||||
|
||||
This will guide you in installing the package
|
||||
|
||||
## Prerequisite
|
||||
[PHP](https://php.net) 7.2+, [Laravel](https://laravel.com) and [Composer](https://getcomposer.org) are required.
|
||||
|
||||
To get the latest version of Flutterwave, simply use composer
|
||||
|
||||
```bash
|
||||
composer require kingflamez/laravelrave
|
||||
```
|
||||
For **`Laravel => 5.5`**, skip this step and go to [**`configuration`**](#configuration)
|
||||
|
||||
Once Flutterwave is installed, you need to register the service provider. Open up `config/app.php` and add the following to the `providers` key.
|
||||
|
||||
```php
|
||||
'providers' => [
|
||||
/*
|
||||
* Package Service Providers...
|
||||
*/
|
||||
...
|
||||
KingFlamez\Rave\RaveServiceProvider::class,
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
Also add this to the `aliases`
|
||||
|
||||
```php
|
||||
'aliases' => [
|
||||
...
|
||||
'Rave' => KingFlamez\Rave\Facades\Rave::class,
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Publish the configuration file using this command:
|
||||
|
||||
```bash
|
||||
php artisan vendor:publish --provider="KingFlamez\Rave\RaveServiceProvider"
|
||||
```
|
||||
|
||||
A configuration-file named **`flutterwave.php`** will be placed in your **`config`** directory
|
||||
|
||||
## Usage
|
||||
|
||||
Open your .env file and add your public key, secret key, environment variable and logo url like so:
|
||||
|
||||
Get your keys form [here](https://dashboard.flutterwave.com/dashboard/settings/apis)
|
||||
|
||||
```php
|
||||
FLW_PUBLIC_KEY=FLWPUBK-xxxxxxxxxxxxxxxxxxxxx-X
|
||||
FLW_SECRET_KEY=FLWSECK-xxxxxxxxxxxxxxxxxxxxx-X
|
||||
FLW_SECRET_HASH='My_lovelysite123'
|
||||
```
|
||||
|
||||
* **FLW_PUBLIC_KEY -** This is the api public key gotten from your dashboard (compulsory)
|
||||
|
||||
* **FLW_SECRET_KEY -** This is the api secret key gotten from your dashboard (compulsory)
|
||||
|
||||
* **FLW_SECRET_HASH -** This is the secret hash for your webhook
|
||||
169
vendor/kingflamez/laravelrave/docs/getting-started/payment-implementation.md
vendored
Normal file
169
vendor/kingflamez/laravelrave/docs/getting-started/payment-implementation.md
vendored
Normal file
@@ -0,0 +1,169 @@
|
||||
# Payment Modal Implementation
|
||||
|
||||
Initiating Flutterwave Payment Modal is simple using this package:
|
||||
|
||||
## 1. Setup Routes
|
||||
|
||||
```php
|
||||
// The page that displays the payment form
|
||||
Route::get('/', function () {
|
||||
return view('welcome');
|
||||
});
|
||||
// The route that the button calls to initialize payment
|
||||
Route::post('/pay', [FlutterwaveController::class, 'initialize'])->name('pay');
|
||||
// The callback url after a payment
|
||||
Route::get('/rave/callback', [FlutterwaveController::class, 'callback'])->name('callback');
|
||||
```
|
||||
|
||||
## 2. Setup the Payment Page
|
||||
|
||||
A sample payment button will look like so:
|
||||
|
||||
> welcome.blade.php
|
||||
|
||||
```html
|
||||
<h3>Buy Movie Tickets N500.00</h3>
|
||||
<form method="POST" action="{{ route('pay') }}" id="paymentForm">
|
||||
{{ csrf_field() }}
|
||||
|
||||
<input name="name" placeholder="Name" />
|
||||
<input name="email" type="email" placeholder="Your Email" />
|
||||
<input name="phone" type="tel" placeholder="Phone number" />
|
||||
|
||||
<input type="submit" value="Buy" />
|
||||
</form>
|
||||
```
|
||||
|
||||
## 3. Setup your Controller
|
||||
|
||||
> Setup your controller to handle the routes. I created the `FlutterwaveController`. Use the `Rave` as `Flutterwave`
|
||||
> facade.
|
||||
|
||||
### Example
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
namespace App\Http\Controllers;
|
||||
|
||||
use KingFlamez\Rave\Facades\Rave as Flutterwave;
|
||||
|
||||
class FlutterwaveController extends Controller
|
||||
{
|
||||
/**
|
||||
* Initialize Rave payment process
|
||||
* @return void
|
||||
*/
|
||||
public function initialize()
|
||||
{
|
||||
//This generates a payment reference
|
||||
$reference = Flutterwave::generateReference();
|
||||
|
||||
// Enter the details of the payment
|
||||
$data = [
|
||||
'payment_options' => 'card,banktransfer',
|
||||
'amount' => 500,
|
||||
'email' => request()->email,
|
||||
'tx_ref' => $reference,
|
||||
'currency' => "NGN",
|
||||
'redirect_url' => route('callback'),
|
||||
'customer' => [
|
||||
'email' => request()->email,
|
||||
"phonenumber" => request()->phone,
|
||||
"name" => request()->name
|
||||
],
|
||||
|
||||
"customizations" => [
|
||||
"title" => 'Movie Ticket',
|
||||
"description" => "20th October"
|
||||
]
|
||||
];
|
||||
|
||||
$payment = Flutterwave::initializePayment($data);
|
||||
|
||||
|
||||
if ($payment['status'] !== 'success') {
|
||||
// notify something went wrong
|
||||
return;
|
||||
}
|
||||
|
||||
return redirect($payment['data']['link']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Obtain Rave callback information
|
||||
* @return void
|
||||
*/
|
||||
public function callback()
|
||||
{
|
||||
|
||||
$transactionID = Flutterwave::getTransactionIDFromCallback();
|
||||
$data = Flutterwave::verifyTransaction($transactionID);
|
||||
|
||||
dd($data);
|
||||
// Get the transaction from your DB using the transaction reference (txref)
|
||||
// Check if you have previously given value for the transaction. If you have, redirect to your successpage else, continue
|
||||
// Confirm that the $data['data']['status'] is 'successful'
|
||||
// Confirm that the currency on your db transaction is equal to the returned currency
|
||||
// Confirm that the db transaction amount is equal to the returned amount
|
||||
// Update the db transaction record (including parameters that didn't exist before the transaction is completed. for audit purpose)
|
||||
// Give value for the transaction
|
||||
// Update the transaction to note that you have given value for the transaction
|
||||
// You can also redirect to your success page from here
|
||||
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Once the initialize is called, you get redirected to a flutterwave payment page
|
||||
|
||||
|
||||
|
||||
> After a successful payment, the user is redirected to the call back page
|
||||
### Payment Parameters
|
||||
|
||||
| Parameter | Required | Description |
|
||||
| --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| tx_ref | True | Your transaction reference. This MUST be unique for every transaction |
|
||||
| amount | True | Amount to charge the customer. |
|
||||
| currency | False | currency to charge in. Defaults to NGN |
|
||||
| integrity_hash | False | This is a sha256 hash of your FlutterwaveCheckout values, it is used for passing secured values to the payment gateway. |
|
||||
| payment_options | True | This specifies the payment options to be displayed e.g - card, mobilemoney, ussd and so on. |
|
||||
| payment_plan | False | This is the payment plan ID used for Recurring billing |
|
||||
| redirect_url | True | URL to redirect to when a transaction is completed. This is useful for 3DSecure payments so we can redirect your customer back to a custom page you want to show them. |
|
||||
| customer | True | This is an object that can contains your customer details: e.g - 'customer': `[ 'email' => 'example@example.com', 'phonenumber' => '08012345678', 'name' => 'Takeshi Kovacs' ]` |
|
||||
| subaccounts | False | This is an array of objects containing the subaccount IDs to split the payment into. Check our Split Payment page for more info |
|
||||
| meta | False | This is an object that helps you include additional payment information to your request e.g `[ 'consumer_id' => 23, 'consumer_mac' => '92a3-912ba-1192a']` |
|
||||
| customizations | True | This is an object that contains title, logo, and description you want to display on the modal e.g `[ 'title' => 'Pied Piper Payments' 'description' => 'Middleout isn't free. Pay the price', 'logo' => 'https://assets.piedpiper.com/logo.png' ]` |
|
||||
| subaccounts | False | This is an array of objects containing the subaccount IDs to split the payment into. Check our Split Payment page for more info |
|
||||
| meta | False | This is an object that helps you include additional payment information to your request e.g `[ 'consumer_id' => 23, 'consumer_mac' => '92a3-912ba-1192a' ]` |
|
||||
| customizations | True | This is an object that contains title, logo, and description you want to display on the modal e.g `[ 'title' => 'Pied Piper Payments', 'description' => 'Middleout isn't free. Pay the price', 'logo' => 'https://assets.piedpiper.com/logo.png' ]` |
|
||||
|
||||
#### Available payment options
|
||||
|
||||
To use custom options for your payment modal, you need to go to your [accounts](https://dashboard.flutterwave.com/dashboard/settings/accounts) page and uncheck `Enable Dashboard Payment Options`
|
||||
|
||||
Here are all the possible values for payment options available on Flutterwave:
|
||||
|
||||
- account
|
||||
- card
|
||||
- banktransfer
|
||||
- mpesa
|
||||
- mobilemoneyrwanda
|
||||
- mobilemoneyzambia
|
||||
- qr
|
||||
- mobilemoneyuganda
|
||||
- ussd
|
||||
- credit
|
||||
- barter
|
||||
- mobilemoneyghana
|
||||
- payattitude
|
||||
- mobilemoneyfranco
|
||||
- paga
|
||||
- 1voucher
|
||||
- mobilemoneytanzania
|
||||
|
||||
|
||||
### Alternate Confirmation
|
||||
|
||||
Apart from callback, you can also use Webhook to receive notifications for your transactions. Click [here](/verification/webhook.html) to set it up
|
||||
Reference in New Issue
Block a user