Subiendo proyecto completo sin restricciones de git ignore

vendor/kingflamez/laravelrave/docs/payments/payment-modal.md

@@ -0,0 +1,91 @@
+# Payment Modal
+
+## 1. Initiating a Payment
+
+```php
+<?php
+
+//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) {
+    // notify something went wrong
+    return;
+}
+
+return redirect($payment['link']);
+
+```
+
+### 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
+
+## 2. Verifying a Payment:
+
+```php
+<?php
+
+$data = Flutterwave::verifyTransaction(request()->transaction_id);
+```