engalirock / laravel-paymob
Laravel v10 PayMob在线支付网关包
Requires
- php: >=8.1
- laravel/framework: 10.*
README
一个Laravel在线支付网关。
目录
安装
通过composer安装
$ composer require engalirock/laravel-paymob
在config/app.php
文件中
'providers' => [ ... aliRocK\PayMob\PayMobServiceProvider::class, ... ]; 'aliases' => [ ... 'PayMob' => aliRocK\PayMob\Facades\PayMob::class, ... ];
首先,在WeAccept门户上创建一个账户,运行以下命令生成PayMob配置文件
$ php artisan vendor:publish
然后在config/paymob.php
文件中填写凭据。确保在仪表板上创建一个iframe并获取支付请求的集成ID。
在集成详情中填写处理回调和响应回调路由,使用PayMobController
中的processedCallback
和invoice
方法的路由
在PayMob服务器上执行交易步骤
- API认证请求
- 订单注册请求
- 支付密钥生成请求
- 准备客户端代码以执行支付请求(Web客户端和移动应用)
- 商户通知端点
- 交易响应端点
有关更多信息,请参阅PayMob在线指南。
1. API认证请求(服务器端)
在此步骤中,您需要向PayMob的认证API发送POST请求以获取认证令牌
使用PayMob Facade进行请求。
$auth = PayMob::authPaymob(); // Run this method to get a sample response of auth request. PayMob::sample('authPaymob');
此方法从config/paymob.php
文件获取凭据,因此首先填写username
和password
以进行此认证请求。
2. 订单注册请求(服务器端)
在此步骤中,您将在Paymob Accept上注册一个订单,以便您可以使用交易后来支付它。
$paymobOrder = PayMob::makeOrderPaymob( $auth->token, // this is token from step 1. $auth->profile->id, // this is the merchant id from step 1. $order->totalCost * 100, // total amount by cents/piasters. $order->id // your (merchant) order id. ); // Run this method to get a sample response of make order request. PayMob::sample('makeOrderPaymob');
将返回的paymob订单ID存储在您的数据库中,以便将来使用此ID进行交易。
3. 支付密钥生成请求(服务器端)
在此步骤中,您将获得一个payment_key
令牌。此密钥将用于验证您的支付请求。
$paymentKey = PayMob::getPaymentKeyPaymob( $auth->token, // from step 1. $order->totalCost * 100, // total amount by cents/piasters. $order->paymob_order_id, // paymob order id from step 2. // For billing data $user->email, // optional $user->firstname, // optional $user->lastname, // optional $user->phone, // optional $city->name, // optional $country->name // optional ); // Run this method to get a sample response of payment key request. PayMob::sample('getPaymentKeyPaymob');
4. 准备客户端代码以执行支付请求(Web客户端和移动应用)(客户端)
现在您已获得支付密钥,您需要准备您的结账体验(即客户端代码)。
网站/网络应用的iframe
PayMob推荐iframe
<form id="paymob_checkout"> <label for="">Card number</label> <input type="text" value="4987654321098769" paymob_field="card_number"> <br> <label for="">Card holdername</label> <input type="text" value="Test Account" paymob_field="card_holdername"> <br> <label for="">Card month</label> <input type="text" value="05" paymob_field="card_expiry_mm"> <br> <label for="">Card year</label> <input type="text" value="21" paymob_field="card_expiry_yy"> <br> <label for="">Card cvn</label> <input type="text" value="123" paymob_field="card_cvn"> <input type="hidden" value="CARD" paymob_field="subtype"> <input type="checkbox" value="tokenize" name="save card"> <label for="save card">save card</label> <input type="submit" value="Pay"> <br> </form>
<iframe src="https://accept.paymobsolutions.com/api/acceptance/iframes/{{config('paymob.iframe_id')}}?payment_token={{$paymentKey->token}}"></iframe>
移动客户端
对于移动应用,您需要导入Accept原生iOS或Android SDK以进行支付和/或保存卡详情。
请通过电子邮件support@weaccept.co请求所需的SDK。有关更多信息,请访问PayMob移动指南
$payment = PayMob::makePayment( $paymentKey->token, // payment key token from step 3. $request->card_number, $request->card_holdername, $request->card_expiry_mm, $request->card_expiry_yy, $request->card_cvn, $order->paymob_order_id, // PayMob order id from step 2. $user->firstname, $user->lastname, $user->email, $user->phone ); // Run this method to get a sample response of make payment for API request. // processedCallback is for the post response to your processed callback route from PayMob. PayMob::sample('processedCallback'); // responseCallback is for the Get response to your response callback route from PayMob. PayMob::sample('responseCallback');
您可以使用一些测试卡进行测试支付。
您可以使用PayMob::sample()
运行来查看可用的示例。
PayMobController
我们在PayMobController
中有4种方法。
首先使用checkingOut
方法显示带有iframe的支付表单页面。或者,对于移动客户端,您可以简单地使用payAPI
方法进行支付。
然后,我们有一个用于捕获 PayMob 服务器端 POST
回调响应的 processedCallback
方法,以及用于捕获 GET
回调响应并显示您的发票页面的 invoice
方法。
将所有 #code ...
替换为您的逻辑。
别忘了为这些方法创建路由,并将 processedCallback
和 invoice
路由保存在 PayMob 控制台中的集成详情中。
PayMob Postman收藏夹
这里有 PayMob 请求的 Postman 收集。
其他PayMob方法
有一些 GET
方法可以用来从 PayMob 获取您的数据。
1. 获取所有订单
PayMob::getOrders( $auth->token, // token from step 1. $page // optional for pagination, by default set to 1 );
2. 获取特定订单
PayMob::getOrder( $auth->token, // token from step 1. $order->paymob_order_id // PayMob order id from step 2. );
3. 获取所有交易
PayMob::getTransactions( $auth->token, // token from step 1. $page // optional for pagination, by default set to 1 );
4. 获取特定交易
PayMob::getTransaction( $auth->token, // token from step 1. $transactionId // PayMob transaction id from step 4. );
5. 对授权交易进行捕获
如果您的交易类型是 auth
(不是 standalone
),那么您必须通过 capture
方法捕获您的支付。
PayMob::capture( $auth->token, // token from step 1. $transactionId, // the returned id from step 4. $totalCost * 100 // total price/cost in cents/piasters. );
待办事项
- 发票页面。
- 示例交易周期。
- 获取所有订单/交易页面。
- 从后端退款。
- 带有 JS 验证的 Iframe。
- 3D 保护的顶级重定向请求。
许可
Laravel PayMob 是在 MIT 许可证下免费分发的软件。