infosecravindra / laravel-paytm-wallet
使用此包可以轻松地将Paytm钱包集成。此包使用官方的Paytm PHP SDK。
Requires
- php: >=7.3
- illuminate/contracts: >=8.0
- illuminate/support: >=8.0
README
注意:我之所以分支出来,是因为我需要在生产服务器上支持Laravel 8,而我没有时间等待主仓库的更新,此包的全部功劳归功于anandsiddharth
适用于Laravel 5.0及以上版本
简介
使用此包可以轻松地将Paytm钱包集成到您的Laravel应用程序中。此包使用官方的Paytm PHP SDK。
许可证
Laravel Paytm Wallet开源软件,许可协议为MIT许可证
入门指南
要开始使用,请使用以下命令将以下包添加到您的composer.json
文件中。
composer require anandsiddharth/laravel-paytm-wallet
配置
注意:对于Laravel 5.5及以上版本,自动发现会处理以下配置。
当composer成功安装Laravel Paytm Wallet库时,请在您的config/app.php
配置文件中注册Anand\LaravelPaytmWallet\PaytmWalletServiceProvider
。
'providers' => [ // Other service providers... Anand\LaravelPaytmWallet\PaytmWalletServiceProvider::class, ],
此外,将PaytmWallet
外观添加到您的app
配置文件中的aliases
数组中
'aliases' => [ // Other aliases 'PaytmWallet' => Anand\LaravelPaytmWallet\Facades\PaytmWallet::class, ],
将Paytm凭据添加到.env
文件中
PAYTM_ENVIRONMENT=local PAYTM_MERCHANT_ID=YOUR_MERCHANT_ID_HERE PAYTM_MERCHANT_KEY=YOUR_SECRET_KEY_HERE PAYTM_MERCHANT_WEBSITE=YOUR_MERCHANT_WEBSITE PAYTM_CHANNEL=YOUR_CHANNEL_HERE PAYTM_INDUSTRY_TYPE=YOUR_INDUSTRY_TYPE_HERE
还有一步要走....
在您的config/services.php
中添加以下配置
'paytm-wallet' => [ 'env' => env('PAYTM_ENVIRONMENT'), // values : (local | production) 'merchant_id' => env('PAYTM_MERCHANT_ID'), 'merchant_key' => env('PAYTM_MERCHANT_KEY'), 'merchant_website' => env('PAYTM_MERCHANT_WEBSITE'), 'channel' => env('PAYTM_CHANNEL'), 'industry_type' => env('PAYTM_INDUSTRY_TYPE'), ],
注意:所有提到的凭据都是在作为商户注册后由Paytm提供的。
Laravel 7更改
我们的包与Laravel 7兼容,但默认的Laravel安装中的same_site设置已更改,请确保在config/session.php
中将same_site
更改为null
,否则回调将不包括cookies,支付完成后您将被注销。
<?php use Illuminate\Support\Str; return [ /... 'same_site' => null, ];
用法
进行交易
<?php namespace App\Http\Controllers; use PaytmWallet; class OrderController extends Controller { /** * Redirect the user to the Payment Gateway. * * @return Response */ public function order() { $payment = PaytmWallet::with('receive'); $payment->prepare([ 'order' => $order->id, 'user' => $user->id, 'mobile_number' => $user->phonenumber, 'email' => $user->email, 'amount' => $order->amount, 'callback_url' => 'http://example.com/payment/status' ]); return $payment->receive(); } /** * Obtain the payment information. * * @return Object */ public function paymentCallback() { $transaction = PaytmWallet::with('receive'); $response = $transaction->response() // To get raw response as array //Check out response parameters sent by paytm here -> http://paywithpaytm.com/developer/paytm_api_doc?target=interpreting-response-sent-by-paytm if($transaction->isSuccessful()){ //Transaction Successful }else if($transaction->isFailed()){ //Transaction Failed }else if($transaction->isOpen()){ //Transaction Open/Processing } $transaction->getResponseMessage(); //Get Response Message If Available //get important parameters via public methods $transaction->getOrderId(); // Get order id $transaction->getTransactionId(); // Get transaction id } }
确保您在接收付款时在routes.php
文件中提到的callback_url
为post
,例如下面所示
Route::post('/payment/status', 'OrderController@paymentCallback');
重要:callback_url
必须不被csrf保护查看这里了解如何操作
使用订单ID获取交易状态/信息
<?php namespace App\Http\Controllers; use PaytmWallet; class OrderController extends Controller { /** * Obtain the transaction status/information. * * @return Object */ public function statusCheck(){ $status = PaytmWallet::with('status'); $status->prepare(['order' => $order->id]); $status->check(); $response = $status->response() // To get raw response as array //Check out response parameters sent by paytm here -> http://paywithpaytm.com/developer/paytm_api_doc?target=txn-status-api-description if($status->isSuccessful()){ //Transaction Successful }else if($status->isFailed()){ //Transaction Failed }else if($status->isOpen()){ //Transaction Open/Processing } $status->getResponseMessage(); //Get Response Message If Available //get important parameters via public methods $status->getOrderId(); // Get order id $status->getTransactionId(); // Get transaction id } }
启动退款
<?php namespace App\Http\Controllers; use PaytmWallet; class OrderController extends Controller { /** * Initiate refund. * * @return Object */ public function refund(){ $refund = PaytmWallet::with('refund'); $refund->prepare([ 'order' => $order->id, 'reference' => "refund-order-4", // provide refund reference for your future reference (should be unique for each order) 'amount' => 300, // refund amount 'transaction' => $order->transaction_id // provide paytm transaction id referring to this order ]); $refund->initiate(); $response = $refund->response() // To get raw response as array if($refund->isSuccessful()){ //Refund Successful }else if($refund->isFailed()){ //Refund Failed }else if($refund->isOpen()){ //Refund Open/Processing }else if($refund->isPending()){ //Refund Pending } } }
检查退款状态
<?php namespace App\Http\Controllers; use PaytmWallet; class OrderController extends Controller { /** * Initiate refund. * * @return Object */ public function refund(){ $refundStatus = PaytmWallet::with('refund_status'); $refundStatus->prepare([ 'order' => $order->id, 'reference' => "refund-order-4", // provide reference number (the same which you have entered for initiating refund) ]); $refundStatus->check(); $response = $refundStatus->response() // To get raw response as array if($refundStatus->isSuccessful()){ //Refund Successful }else if($refundStatus->isFailed()){ //Refund Failed }else if($refundStatus->isOpen()){ //Refund Open/Processing }else if($refundStatus->isPending()){ //Refund Pending } } }
自定义处理中的交易页面
考虑到现代应用程序的用户界面,此包附带默认的“处理中的交易页面”太单调。如果您想修改它,您有这个选项。下面是如何做:您只需要更改OrderController
代码中的1行。
<?php namespace App\Http\Controllers; use PaytmWallet; class OrderController extends Controller { /** * Redirect the user to the Payment Gateway. * * @return Response */ public function order() { $payment = PaytmWallet::with('receive'); $payment->prepare([ 'order' => $order->id, 'user' => $user->id, 'mobile_number' => $user->phonenumber, 'email' => $user->email, 'amount' => $order->amount, 'callback_url' => 'http://example.com/payment/status' ]); return $payment->view('your_custom_view')->receive(); }
在这里,$payment->receive()
被替换为$payment->view('your_custom_view')->receive()
。将your_custom_view
替换为位于您的resources/views/your_custom_view.blade.php
中的视图名称。
此外,在您的视图文件中,请确保在</body>
之前(即在关闭body标签之前)添加此行代码,它将重定向到支付网关。
@yield('payment_redirect')
这是一个示例自定义视图
<html> <head> </head> <body> <h1>Custom payment message</h1> @yield('payment_redirect') </body> </html>
这就是全部内容!