storefront / magento2-btcpay-module
Requires
- php: ^7.1.0
- btcpayserver/btcpayserver-php-client: ^1.0
This package is auto-updated.
Last update: 2021-11-15 13:20:32 UTC
README
需求
- 安装Magento 2.3(在社区版2.3.2和PHP 7.2上进行了测试)
- 低于2.3的Magento也应该可以工作,但未进行测试。
- 您的BTCPay服务器必须设置为HTTPS
功能
- 允许您在Magento 2商店中通过BTCPay Server支付
- Magento接收发票更新并更新订单状态
- 支持自定义的Magento订单状态
- 在Magento Admin中查看创建的BTC Pay发票
- 作为安全措施,Magento也会轮询发票更新,以防实时更新未到达Magento
- 多站点和多商店兼容
目标
本模块的目标是在不使用任何其他第三方的情况下,允许在Magento 2中实现比特币、莱特币和其他加密货币支付。本模块还设计得健壮、维护成本低,并作为未来定制的坚实基础,以满足您的业务需求。
如何安装
安装过程就像您使用composer安装其他任何Magento 2模块一样。以下是一些典型步骤
- 通过运行以下命令使用composer添加
Storefront_BTCPay
模块
composer require storefront/magento2-btcpay-module
- 启用新模块
php bin/magento module:enable Storefront_BTCPay
- 运行新模块的安装脚本
php bin/magento setup:upgrade
如何配置
安装后,在“商店 > 配置 > 销售配置 > 支付方法”下将可见新的支付方式。在那里配置字段。
您需要从BTCPay服务器获取一个配对码并输入。
它是如何工作的?
- 当在Magento中下订单并选择BTCPay作为支付方式时,客户将被重定向到您的BTCPay服务器上的支付页面。
- 客户可以那里支付,或者他可以取消他的订单。
- 当他取消时,未付款的订单将被取消,释放保留的库存,并将客户送回购物车页面。此模块将恢复购物车的商品,因此客户不需要从头开始。
- 当客户付款时,BTCPay服务器将通知付款,并将更改的发票状态信号发送给Magento。
- BTCPay服务器将付款状态更改推送到Magento,但Magento也可以自行轮询发票更改。我们将其构建为一个安全网,以防BTCPay服务器无法连接到Magento(例如,在开发期间,在防火墙后面)。
- 从BTCPay服务器到Magento的发票更新是即时的。
- Magento每5分钟轮询一次BTCPay服务器以获取更新。
支持哪些支付方式?
这取决于您对BTCPay服务器的配置。您在BTCPay服务器上激活的所有支付方式都将可供客户使用。
不支持什么?
- BTCPay Server只能配置一个域名,因此您不能有多个BTCPay Server。一个用于整个Magento安装。
谁创建了此模块?
此模块由Storefront创建,Storefront是一家来自比利时的小型Magento集成商,拥有超过10年的经验。访问我们的网站www.storefront.be了解更多关于我们的信息。
此模块不包含任何广告,100%开源且免费使用。
您为什么创建此模块?
- 现有的模块代码质量很差,不符合Magento 2的最佳实践
- 支持度较低(与BTCPay Server结合使用)
- 设置起来很复杂,因为之前的模块基本上是为BitPay设计的
- 我们现在有一个专门针对BTCPay的模块,因此BTCPay Server和此模块都可以自由创新,无需考虑BitPay兼容性
- 更高的代码质量意味着维护更少,并且更容易与未来的Magento版本兼容
如果我的BTCPay Server或Magento离线了一段时间,发票更新可能没有同步,我能做什么?
Magento每5分钟轮询BTCPay Server以更新未完成的发票,所以基本上您不需要做任何事情。这是由cronjob处理的。如果您不想等待5分钟或想查看正在发生的事情,我们已准备好一个控制台命令以手动运行发票同步
bin/magento btcpay:invoice:update
我能否从命令行进行配对?
是的,只需运行以下命令
bin/magento btcpay:pair YOUR-PAIRING-CODE
未来的路线图是什么?
- 由于这是一个第一个版本,我们想从实际日常使用中了解更多,并首先关注稳定性。
- 我们希望为您带来更简单的自动化测试,但为此我们需要在BTCPay Server中进行更改:https://github.com/btcpayserver/btcpayserver/issues/917
- 支持配置多个BTCPay Server,以便您可以为不同的网站/商店安装单独的安装(低优先级)。
- 实际上不需要其他东西,因为此模块以坚固可靠的方式完成了它需要完成的所有事情。
如果我需要帮助怎么办?
就像任何其他开源软件一样,您可以从社区中获得帮助,或者只需在这里的GitHub上打开一个问题。
您可以在BTCPay Server Mattermost #development通道上与Wouter Samaey交谈
如果您更喜欢专业的付费支持,您可以通过info@storefront.be联系Storefront。
如果此模块支持您的业务,请考虑获得付费支持(我们确实免费构建了此模块),并捐赠给BTCPay Server的开发https://btcpayserver.org/#makeADonation