Merge pull request #147 from segun-paystack/iamraphson/add-split-feature

Author: unicodeveloper

README.md

@@ -147,6 +147,13 @@ Route::post('/pay', [
     'as' => 'pay'
 ]);
 ```
+OR
+
+```php
+// Laravel 8
+Route::post('/pay', [App\Http\Controllers\PaymentController::class, 'redirectToGateway'])->name('pay');
+```
+
 
 ```php
 Route::get('/payment/callback', 'PaymentController@handleGatewayCallback');
@@ -161,6 +168,13 @@ Route::get('payment/callback', [
 ]);
 ```
 
+OR
+
+```php
+// Laravel 8
+Route::get('/payment/callback', [App\Http\Controllers\PaymentController::class, 'handleGatewayCallback']);
+```
+
 ```php
 <?php
 
@@ -330,6 +344,23 @@ paystack()->updateSubAccount();
 
 A sample form will look like so:
 
+```php
+<?php
+// more details https://paystack.com/docs/payments/multi-split-payments/#dynamic-splits
+
+$split = [
+   "type" => "percentage",
+   "currency" => "KES",
+   "subaccounts" => [
+    [ "subaccount" => "ACCT_li4p6kte2dolodo", "share" => 10 ],
+    [ "subaccount" => "ACCT_li4p6kte2dolodo", "share" => 30 ],
+   ],
+   "bearer_type" => "all",
+   "main_account_share" => 70
+];
+?>
+```
+
 ```html
 <form method="POST" action="{{ route('pay') }}" accept-charset="UTF-8" class="form-horizontal" role="form">
     <div class="row" style="margin-bottom:40px;">
@@ -347,6 +378,9 @@ A sample form will look like so:
             <input type="hidden" name="currency" value="NGN">
             <input type="hidden" name="metadata" value="{{ json_encode($array = ['key_name' => 'value',]) }}" > {{-- For other necessary things you want to add to your payload. it is optional though --}}
             <input type="hidden" name="reference" value="{{ Paystack::genTranxRef() }}"> {{-- required --}}
+            
+            <input type="hidden" name="split_code" value="SPL_EgunGUnBeCareful"> {{-- to support transaction split. more details https://paystack.com/docs/payments/multi-split-payments/#using-transaction-splits-with-payments --}}
+            <input type="hidden" name="split" value="{{ json_encode($split) }}"> {{-- to support dynamic transaction split. More details https://paystack.com/docs/payments/multi-split-payments/#dynamic-splits --}}
             {{ csrf_field() }} {{-- works only when using laravel 5.1, 5.2 --}}
 
             <input type="hidden" name="_token" value="{{ csrf_token() }}"> {{-- employ this in place of csrf_field only in laravel 5.0 --}}

composer.json

@@ -1,54 +1,66 @@
 {
-    "name": "unicodeveloper/laravel-paystack",
-    "description": "A Laravel Package for Paystack",
-    "keywords": ["php","github", "laravel","Open Source","payments", "subscription", "paystack", "paystack.co","laravel 6", "laravel 7", "laravel 8"],
-    "license": "MIT",
-    "authors": [
-      {
-        "name": "unicodeveloper",
-        "email": "[email protected]"
-      },
-      {
-        "name": "iamfunsho",
-        "email": "[email protected]"
-      }
-   ],
-   "minimum-stability": "stable",
-   "require": {
-    "php": "^7.2",
-    "illuminate/support": "~6|~7|~8",
-    "guzzlehttp/guzzle": "~6|~7"
-   },
-   "require-dev": {
-        "phpunit/phpunit" : "^8.4|^9.0",
-        "scrutinizer/ocular": "~1.1",
-        "php-coveralls/php-coveralls": "^2.0",
-        "mockery/mockery": "^1.3"
-    },
-   "autoload": {
-        "files": [
-              "src/Support/helpers.php"
-            ],
-        "psr-4": {
-          "Unicodeveloper\\Paystack\\": "src/"
-        }
-   },
-   "autoload-dev": {
-        "psr-4": {
-            "Unicodeveloper\\Paystack\\Test\\": "tests"
-        }
+  "name": "unicodeveloper/laravel-paystack",
+  "description": "A Laravel Package for Paystack",
+  "keywords": [
+    "php",
+    "github",
+    "laravel",
+    "Open Source",
+    "payments",
+    "subscription",
+    "paystack",
+    "paystack.co",
+    "laravel 6",
+    "laravel 7",
+    "laravel 8"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "unicodeveloper",
+      "email": "[email protected]"
     },
-    "scripts": {
-        "test": "vendor/bin/phpunit"
-    },
-   "extra": {
+    {
+      "name": "iamfunsho",
+      "email": "[email protected]"
+    }
+  ],
+  "minimum-stability": "stable",
+  "require": {
+    "php": "^7.2|^8.0",
+    "illuminate/support": "~6|~7|~8",
+    "guzzlehttp/guzzle": "~6|~7|~8"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^8.4|^9.0",
+    "scrutinizer/ocular": "~1.1",
+    "php-coveralls/php-coveralls": "^2.0",
+    "mockery/mockery": "^1.3"
+  },
+  "autoload": {
+    "files": [
+      "src/Support/helpers.php"
+    ],
+    "psr-4": {
+      "Unicodeveloper\\Paystack\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Unicodeveloper\\Paystack\\Test\\": "tests"
+    }
+  },
+  "scripts": {
+    "test": "vendor/bin/phpunit"
+  },
+  "extra": {
     "laravel": {
-        "providers": [
-            "Unicodeveloper\\Paystack\\PaystackServiceProvider"
-        ],
-        "aliases": {
-            "Paystack": "Unicodeveloper\\Paystack\\Facades\\Paystack"
-        }
+      "providers": [
+        "Unicodeveloper\\Paystack\\PaystackServiceProvider"
+      ],
+      "aliases": {
+        "Paystack": "Unicodeveloper\\Paystack\\Facades\\Paystack"
+      }
     }
   }
 }

src/Paystack.php

@@ -124,19 +124,43 @@ public function makePaymentRequest( $data = null)
                 "last_name" => request()->last_name,
                 "callback_url" => request()->callback_url,
                 "currency" => (request()->currency != ""  ? request()->currency : "NGN"),
-                
+
                 /*
                     Paystack allows for transactions to be split into a subaccount -
                     The following lines trap the subaccount ID - as well as the ammount to charge the subaccount (if overriden in the form)
                     both values need to be entered within hidden input fields
                 */
                 "subaccount" => request()->subaccount,
                 "transaction_charge" => request()->transaction_charge,
-                
+
+                /**
+                 * Paystack allows for transaction to be split into multi accounts(subaccounts)
+                 * The following lines trap the split ID handling the split
+                 * More details here: https://paystack.com/docs/payments/multi-split-payments/#using-transaction-splits-with-payments
+                 */
+                "split_code" => request()->split_code,
+
+                /**
+                 * Paystack allows transaction to be split into multi account(subaccounts) on the fly without predefined split
+                 * form need an input field: <input type="hidden" name="split" value="{{ json_encode($split) }}" >
+                 * array must be set up as:
+                 *  $split = [
+                 *    "type" => "percentage",
+                 *     "currency" => "KES",
+                 *     "subaccounts" => [
+                 *       { "subaccount" => "ACCT_li4p6kte2dolodo", "share" => 10 },
+                 *       { "subaccount" => "ACCT_li4p6kte2dolodo", "share" => 30 },
+                 *     ],
+                 *     "bearer_type" => "all",
+                 *     "main_account_share" => 70,
+                 * ]
+                 * More details here: https://paystack.com/docs/payments/multi-split-payments/#dynamic-splits
+                 */
+                "split" => request()->split,
                 /*
                 * to allow use of metadata on Paystack dashboard and a means to return additional data back to redirect url
                 * form need an input field: <input type="hidden" name="metadata" value="{{ json_encode($array) }}" >
-                * array must be set up as: 
+                * array must be set up as:
                 * $array = [ 'custom_fields' => [
                 *                   ['display_name' => "Cart Id", "variable_name" => "cart_id", "value" => "2"],
                 *                   ['display_name' => "Sex", "variable_name" => "sex", "value" => "female"],