baselrabia/paymob-with-laravel

PayMob在线支付网关与Laravel PHP框架的集成

dev-master 2021-08-08 16:33 UTC

This package is auto-updated.

Last update: 2024-09-08 23:08:58 UTC


README

一个Laravel在线支付网关。

目录

  1. 安装

  2. 在PayMob服务器上进行交易的步骤

    1. API身份验证请求(服务器端)
    2. 订单注册请求(服务器端)
    3. 支付密钥生成请求(服务器端)
    4. 准备客户端代码以执行支付请求(Web客户端和移动应用)(客户端)
      1. 网站/网络应用的iframe
      2. 移动客户端
  3. PayMob控制器

  4. PayMob Postman收藏集

  5. 其他PayMob方法

  6. 待办事项

  7. 许可证

安装

通过composer要求

composer require baselrabia/paymob-with-laravel

Laravel<=5.* 在 config/app.php 文件中

'providers' => [
    ...
    Basel\PayMob\PayMobServiceProvider::class,
    ...
];

'aliases' => [
    ...
    'PayMob' => Basel\PayMob\Facades\PayMob::class,
    ...
];

首先,在WeAccept门户上创建一个账户,运行以下命令以生成PayMob配置文件

$ php artisan vendor:publish --provider="Basel\PayMob\PayMobServiceProvider"

然后,在config/paymob.php文件中填写凭证。请确保在您的仪表板上创建一个iframe并获取支付请求的集成ID。

在集成详情中填写处理回调和响应回调路由,使用PayMobController中的processedCallbackinvoice方法的路由

在PayMob服务器上进行交易的步骤

  1. API身份验证请求
  2. 订单注册请求
  3. 支付密钥生成请求
  4. 准备客户端代码以执行支付请求(Web客户端和移动应用)
  5. 商户通知端点
  6. 交易响应端点

您可以参考PayMob在线指南获取更多信息。

1. API身份验证请求(服务器端)

在此步骤中,您需要向PayMob的身份验证API执行POST请求以获取身份验证令牌

使用PayMob外观进行请求。

$auth = PayMob::authPaymob();
// Run this method to get a sample response of auth request.
PayMob::sample('authPaymob');

此方法从config/paymob.php文件中获取凭证,因此请先填写usernamepassword以执行此身份验证请求。

2. 订单注册请求(服务器端)

在此步骤中,您将在Paymob Accept上注册一个订单,以便您可以使用交易支付它。

$paymobOrder = PayMob::makeOrderPaymob(
    $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(
    $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()来查看可用的示例。

PayMob控制器

PayMobController中我们有4个方法。

首先使用checkingOut方法显示带有iframe的支付表单页面。或者,对于移动客户端,简单地使用payAPI方法进行支付。

然后,我们有 processedCallback 方法来捕获来自 PayMob 服务器的 POST 回调响应,以及 invoice 方法来捕获 GET 回调响应并显示您的发票页面。

将所有 #code ... 替换为您的逻辑。

别忘了为这些方法创建路由,并将 processedCallbackinvoice 路由保存在 PayMob 控制台的集成详情中。

PayMob Postman收藏集

这里有针对 PayMob 请求的 Postman 集合

其他PayMob方法

有一些 GET 方法可以获取您从 PayMob 的数据。

1. 获取所有订单

PayMob::getOrders(
    $page // optional for pagination, by default set to 1
);

2. 获取特定订单

PayMob::getOrder(
    $order->paymob_order_id // PayMob order id from step 2.
);

3. 获取所有交易

PayMob::getTransactions(
    $page // optional for pagination, by default set to 1
);

4. 获取特定交易

PayMob::getTransaction(
    $transactionId // PayMob transaction id from step 4.
);

5. 为授权交易捕获

如果您的交易类型是 auth(非 standalone),那么您必须通过 capture 方法捕获您的付款。

PayMob::capture(
    $transactionId, // the returned id from step 4.
    $totalCost * 100 // total price/cost in cents/piasters.
);

待办事项

  1. 发票页面。
  2. 示例交易周期。
  3. 获取所有订单/交易页面。
  4. 从后端退款。
  5. 带有 JS 验证的 Iframe。
  6. 3D secure 的顶级重定向请求。

许可证

Laravel PayMob 是在 MIT 许可条款下免费分发的软件。