Table of Contents

Installation

composer require victorybiz/laravel-crypto-payment-gateway

php artisan vendor:publish --provider="Victorybiz\LaravelCryptoPaymentGateway\LaravelCryptoPaymentGatewayServiceProvider"

Requirements

Dependencies

Configuration

Define payment routes

// routes/web.php// You can protect the 'payments.crypto.pay' route with `auth` middleware to allow access by only authenticated userRoute::match(['get','post'],'/payments/crypto/pay',Victorybiz\LaravelCryptoPaymentGateway\Http\Controllers\CryptoPaymentController::class)                ->name('payments.crypto.pay');// You you need to create your own callback controller and define the route below// The callback route should be a publicly accessible route with no auth// However, you may also exclude the route from CSRF Protection by adding their URIs to the $except property of the VerifyCsrfToken middleware.Route::post('/payments/crypto/callback', [App\Http\Controllers\Payment\PaymentController::class,'callback'])                ->withoutMiddleware(['web','auth']);

Define the public key and private keys in environment file

GOURL_PAYMENTBOX_BITCOIN_PUBLIC_KEYGOURL_PAYMENTBOX_BITCOIN_PRIVATE_KEYGOURL_PAYMENTBOX_BITCOINCASH_PUBLIC_KEYGOURL_PAYMENTBOX_BITCOINCASH_PRIVATE_KEY

Config Options

Usage

Payment Data Submission

Usage with Form Submit

<formid="payment-form"method="post"action="{{ route('payments.crypto.pay) }}">  @csrf<inputtype="text"name="amountUSD"placeholder="Amount"><inputtype="hidden"name="userID"value="{{ Auth::user()->id }}"><inputtype="hidden"name="orderID"value="1"><inputtype="hidden"name="redirect"value="{{ url()->full() }}"><buttontype="submit">Pay</button></form>

Usage with AJAX Request

axios({method:"post",url:"/payments/crypto/pay",data:{amountUSD:20.50,userID:1,orderID:101,redirect:'https://domain.com/redirect-url',},headers:{'Accept':'application/json'// Ensure you include your TOKEN as well},}).then(function(response){// The url is available in `data` key of the json response:// {//   status: true,//   message: 'Request successful.',//   data: 'https://your-domain.com/payments/crypto/pay?cryptopsid=some-unique-token-string'// }if(response.data.status===true){constpaymentUrl=response.data.datawindow.location=paymentUrl}}).catch(function(response){//handle errorconsole.log(response);});

Usage with Session Redirect (through controller, Livewire component or anywhere in your application)

// This could be in a controller method or livewire component methoduseVictorybiz\LaravelCryptoPaymentGateway\LaravelCryptoPaymentGateway;$payment_url = LaravelCryptoPaymentGateway::startPaymentSession(['amountUSD' =>$validatedData['amount'],// OR 'amount' when sending BTC value'orderID' =>$product->id,'userID' => Auth::user()->id,'redirect' =>url()->full(),]);// redirect to the payment pageredirect()->to($payment_url);

The Callback

Callback Controller

<?phpnamespaceApp\Http\Controllers\Payment;useApp\Http\Controllers\Controller;useIlluminate\Http\Request;useIlluminate\Support\Facades\Auth;useVictorybiz\LaravelCryptoPaymentGateway\LaravelCryptoPaymentGateway;class PaymentControllerextends Controller{/**     * Cryptobox callback.     */publicfunctioncallback(Request$request)    {return LaravelCryptoPaymentGateway::callback();    }}

Callback Route

// routes/web.php Route::post('/payments/crypto/callback', [App\Http\Controllers\Payment\PaymentController::class,'callback'])                ->withoutMiddleware(['web','auth']);

IPN (Instant Payment Notification)

<?phpnamespaceApp\Http\Controllers\Payment;useApp\Http\Controllers\Controller;useIlluminate\Http\Request;useIlluminate\Support\Facades\Auth;useVictorybiz\LaravelCryptoPaymentGateway\LaravelCryptoPaymentGateway;class PaymentControllerextends Controller{//.../**     * Cryptobox IPN Example     *     * @param \Victorybiz\LaravelCryptoPaymentGateway\Models\CryptoPaymentModel $cryptoPaymentModel     * @param array $payment_details     * @param string $box_status     * @return bool     */publicstaticfunctionipn($cryptoPaymentModel,$payment_details,$box_status)    {if ($cryptoPaymentModel) {/*            // ADD YOUR CODE HERE            // ------------------            // For example, you have a model `UserOrder`, you can create new Bitcoin payment record to this model            $userOrder = UserOrder::where('payment_id', $cryptoPaymentModel->paymentID)->first();            if (!$userOrder)            {                UserOrder::create([                    'payment_id' => $cryptoPaymentModel->paymentID,                    'user_id'    => $payment_details["user"],                    'order_id'   => $payment_details["order"],                    'amount'     => floatval($payment_details["amount"]),                    'amountusd'  => floatval($payment_details["amountusd"]),                    'coinlabel'  => $payment_details["coinlabel"],                    'txconfirmed'  => $payment_details["confirmed"],                    'status'     => $payment_details["status"],                ]);            }            // ------------------            // Received second IPN notification (optional) - Bitcoin payment confirmed (6+ transaction confirmations)            if ($userOrder && $box_status == "cryptobox_updated")            {                $userOrder->txconfirmed = $payment_details["confirmed"];                $userOrder->save();            }            // ------------------            */// Onetime action when payment confirmed (6+ transaction confirmations)if (!$cryptoPaymentModel->processed &&$payment_details["confirmed"])            {// Add your custom logic here to give value to the user.// ------------------// set the status of the payment to processed// $cryptoPaymentModel->setStatusAsProcessed();// ------------------// Add logic to send notification of confirmed/processed payment to the user if any            }                    }returntrue;    }}

// config/laravel-crypto-payment-gateway.php/** * Hook IPN (Instant payment notification) to the following static class method. * In this static class method, you can  add your custom logic and give value to the user once your confirmed payment box status. * You can also add payment notification logic. * This can be a static class method defined anywhere in your application. * This can also be static method/action defined in controller class but route must not be defined for the action. * * The Static Method Definition in your class: * @param \Victorybiz\LaravelCryptoPaymentGateway\Models\CryptoPaymentModel $cryptoPaymentModel * @param array $payment_details * @param string $box_status * @return bool * public static function ipn($cryptoPaymentModel, $payment_details, $box_status) * { *  // Add your custom logic here. *  return true; * } * * Example: [\Victorybiz\LaravelCryptoPaymentGateway\Http\Controllers\CryptoPaymentController::class, 'ipn'] */'hook_ipn' => [\App\Http\Controllers\Payment\PaymentController,'ipn'],

Eloquent Model forcrypto_payments table

useVictorybiz\LaravelCryptoPaymentGateway\Models\CryptoPaymentModel;$cryptoPayment = CryptoPaymentModel::find($paymentID);$cryptoPayment = CryptoPaymentModel::where('paymentID',$paymentID);$processedCryptoPayment = CryptoPaymentModel::where('processed',true);

Advanced Usage

Instance of GoUrl.io PHP Class API (cryptobox.class.php)

useVictorybiz\LaravelCryptoPaymentGateway\LaravelCryptoPaymentGateway;$laravelCryptoPaymentGateway =newLaravelCryptoPaymentGateway;$cryptobox =$laravelCryptoPaymentGateway->getCryptobox($options = []);$payment_history =$cryptobox->payment_history($boxID ="",$orderID ="",$userID ="",$countryID ="",$boxType ="",$period ="7 DAY");

Resources

Testing

composertest

Changelog

Contributing

Security

Credits

License

Laravel Package Boilerplate