vasadibt / barion-web-php
Barion 网络API
Requires
- php: >=7.2
- ext-curl: *
This package is auto-updated.
Last update: 2024-09-12 18:16:15 UTC
README
BarionPHP 是一个紧凑的PHP库,用于通过 Barion智能网关 管理在线电子货币和卡片支付。它允许您仅用几行代码即可接受信用卡和电子货币支付。
BarionPHP 让您可以
- 轻松启动在线即时或预订支付
- 获取有关特定支付的详细信息
- 完全或部分完成进行中的预订支付,支持自动退款
- 完全或部分退款完成的支付交易
只需几行简单的代码即可实现所有操作!
版本历史
- 1.4.2 2019年8月15日。
- 1.4.1 2019年8月14日。
- 1.4.0 2019年8月8日。
- 1.3.2 2019年8月5日。
- 1.3.1 2019年3月20日。
- 1.3.0 2019年3月12日。
- 1.2.9 2017年5月16日。
- 1.2.8 2017年4月13日。
- 1.2.7 2017年2月14日。
- 1.2.5 2016年11月7日。
- 1.2.4 2016年5月25日。
- 1.2.3 2016年1月14日。
- 1.2.2 2016年1月11日。
- 1.1.0 2015年11月27日。
- 1.0.1 2015年11月26日。
- 1.0.0 2015年11月17日。
有关版本变更的详细信息,请参阅 changelog.txt 文件。
系统要求
- PHP 5.6或更高版本
- cURL模块启用(至少v7.18.1)
- SSL启用(至少使用0.9.8f版本的OpenSSL的系统)
安装
将 barion 库的内容复制到所需的文件夹中。确保在运行PHP脚本时可以访问该路径。
基本用法
在您的PHP脚本中包含 BarionClient 类
require_once 'library/BarionClient.php';
然后实例化一个Barion客户端。为此,您必须提供三个参数。
首先,Barion中注册的在线商店的秘密密钥(称为POSKey)
$myPosKey = "9c165cfc-cbd1-452f-8307-21a3a9cee664";
API版本号(默认为2)
$apiVersion = 2;
要连接的环境。这可以是测试系统或生产环境。
// Test environment $environment = \Barion\common\BarionEnvironment::Test; // Production environment $environment = \Barion\common\BarionEnvironment::Prod;
使用这些参数,您可以创建一个 BarionClient 类的实例
$BC = new \Barion\BarionClient($myPosKey, $apiVersion, $environment);
如果您遇到SSL连接问题,则可以将第四个参数设置为true: $useBundledRootCerts
这将使用捆绑的根证书列表而不是服务器提供的证书。
基本流程
使用该库管理支付流程包括两个步骤
1. 启动支付
1.1. 创建请求对象
要启动在线支付,您必须创建一个或多个 Payment Transaction 对象,将交易 Items 添加到它们中,然后将这些交易组合在一个 Payment 对象中。
首先,创建一个 ItemModel
$item = new \Barion\models\common\ItemModel(); $item->Name = "TestItem"; $item->Description = "A test product"; $item->Quantity = 1; $item->Unit = "piece"; $item->UnitPrice = 1000; $item->ItemTotal = 1000; $item->SKU = "ITEM-01";
然后创建一个 PaymentTransactionModel 并将上面提到的 Item 添加到它
$trans = new \Barion\models\payment\PaymentTransactionModel(); $trans->POSTransactionId = "TRANS-01"; $trans->Payee = "webshop@example.com"; $trans->Total = 1000; $trans->Currency = \Barion\common\Currency::HUF; $trans->Comment = "Test transaction containing the product"; $trans->AddItem($item);
最后,创建一个 PreparePaymentRequestModel 并将上面提到的 PaymentTransactionModel 添加到它
$ppr = new \Barion\models\payment\PreparePaymentRequestModel(); $ppr->GuestCheckout = true; $ppr->PaymentType = \Barion\common\PaymentType::Immediate; $ppr->FundingSources = array(\Barion\common\FundingSourceType::All); $ppr->PaymentRequestId = "PAYMENT-01"; $ppr->PayerHint = "user@example.com"; $ppr->Locale = \Barion\common\UILocale::EN; $ppr->OrderNumber = "ORDER-0001"; $ppr->Currency = \Barion\common\Currency::HUF; $ppr->ShippingAddress = "12345 NJ, Example ave. 6."; $ppr->RedirectUrl = "http://webshop.example.com/afterpayment"; $ppr->CallbackUrl = "http://webshop.example.com/processpayment"; $ppr->AddTransaction($trans);
注意:用于身份验证的秘密 POSKey 不是请求对象的一部分。Barion客户端类会自动将此值注入到发送到Barion API的每个请求中。
1.2. 调用Barion API
现在您可以使用刚刚创建的请求模型调用Barion客户端的 PreparePayment 方法
$myPayment = $BC->PreparePayment($ppr);
Barion API现在准备了一个可以被任何人支付的支付实体。
$myPayment 变量持有从Barion API收到的响应,这是一个 PreparePaymentResponseModel 对象的实例。
1.3. 将用户重定向到Barion智能网关
您可以使用响应中的 PaymentId 值将用户重定向到Barion智能网关。您必须在 Id 查询字符串参数中提供此标识符。完整的重定向URL看起来像这样
https://secure.barion.com/Pay?id=<your_payment_id>
用户现在可以在Barion智能网关完成支付。
2. 获取支付信息
在这个例子中,我们将获取上面创建的支付的详细信息。
2.1. 创建请求对象
要请求支付详情,您只需要一个参数:支付标识符。这就是我们之前用来重定向用户的 PaymentId。
64157032-d3dc-4296-aeda-fd4b0994c64e
2.2. 调用Barion API
要请求支付详情,我们使用上面提到的标识符调用Barion客户端类的 GetPaymentState 方法
$paymentDetails = $BC->GetPaymentState("64157032-d3dc-4296-aeda-fd4b0994c64e");
根据响应中收到的支付状态和参数,商店现在可以决定支付是否成功。
基本故障排除
以下是一些您在联系我们的支持之前可能想检查的常见错误
15. 在发送我的请求时我得到了一个“用户身份验证失败”错误
- 检查您是否将正确的POSkey发送到正确的环境,例如,如果您想在测试环境中调用API,请使用您在TEST网站上注册的商店的POSkey。
- 检查发送的数据是否实际上是一个有效的JSON字符串,没有任何特殊字符、分隔符、换行符或无效编码。
18. 在测试环境中我得到了“商店已关闭”的错误信息
- 检查在登录到Barion测试网站后您的商店是否已打开。请注意,您必须填写商店的每一项数据,然后将其发送以供审批。在此之后,审批将自动完成,您的商店将处于打开状态。这仅适用于测试环境。
更多示例
要查看更多关于Barion库使用的示例,请参阅存储库中的 docs 和 examples 文件夹。
© 2017 Barion Payment Inc.