WebShopX-Payments: Payment Plugin for WebShopX

WebShopX-Payments bridges real-world payment gateways with WebShopX.

Quick Links

---

Key Features

WebShopX-Payments (also known as WSXPay) serves as the payment provider (underlying service provider) plugin for WebShopX. It seamlessly connects real-world currency payments with Minecraft servers running WebShopX.

• WebShopX: Handles core business logic, including player account balances, top-up order management, product display, purchasing logic, redeem codes, and delivery (player claiming / execution of recharge commands).
• WebShopX-Payments: Focuses exclusively on the payment pipeline. This includes requesting embedded payment backends to create transactions, polling or receiving callback payment statuses, matching webhook payment notifications, and ultimately reporting successful payment statuses back to WebShopX.

📌 Deployment Prerequisite: This is an optional dependency plugin and must be used in conjunction with the core WebShopX plugin. It does not handle products or delivery logic on its own; installing it standalone will not provide any business functionality.

---

Supported Payment Methods

This page summarizes the payment solutions currently supported or implemented by WebShopX-Payments, allowing you to quickly evaluate availability and integration priorities.

| Status | Platform | Solution | Description |
| :--- | :--- | :--- | :--- |
| 🟢 | Alipay | QR Code Payment (Order-based) | Official API. The server calls the official API to generate a dynamic payment QR code for users to scan and pay. |
| 🔵 | WeChat Pay | Native Payment | Official API. Standard QR code payment mode. The system generates a QR code, and scanning it launches the standard WeChat checkout window. |
| 🟢 | PayPal | REST API v2 | Official API. Calls the official PayPal Orders API to dynamically generate payment approval links or QR codes. |
| 🟡 | MercadoPago | Pro Checkout | Official API. Integration with the official MercadoPago interface. |
| 🟢 | Stripe | Checkout / Elements | Official API. Integrated with its standard web payment flow, supporting multi-currency and various international credit cards. |
| 🔵 | Alipay | No-License Hook | Third-party Solution. The backend configures a fixed-amount receiving QR code and intercepts open platform transaction notifications or billing info via Hook for automated callbacks. |
| 🔵 | WeChat Pay | No-License Hook | Third-party Solution. The backend configures a fixed-amount receiving QR code and intercepts real-time payment notifications from WeChat PC client via Hook to match amounts and confirm payments. |

• 🟢 Fully Verified: The solution is viable. Developers have completed full-process closed-loop testing and confirmed it functions normally.
• 🔵 Indirectly Verified: The solution is viable. Tested and successfully reported by other users, though not personally verified by the developers.
• 🟡 Pending Verification: The code has been implemented. However, due to developers lacking relevant API permissions/credentials, actual testing has not yet been performed.

---

Quick Start

1. Place WebShopX-Payments.jar into your server's plugins folder.
2. Restart the server to generate the default configuration files.
3. Open the plugins/WebShopX-Payments/ directory, modify the configuration files, and refer to the Official Wiki to configure your required payment gateway parameters.
4. Restart the server.
5. Check and enable the recognized payment methods on the WebShopX admin.html page.

---

In-Game Commands

| Command | Description |
| :--- | :--- |
| /wsxpay help | View help information |
| /wsxpay reload | Reload configuration |
| /wsxpay status | View the current status of the plugin |

---

Ideal For

• Server owners currently using WebShopX who want to integrate multiple payment gateways.
• Server owners looking to connect real-world payment methods to their server.

---

📌 Secondary Development & Copyright Notice

This plugin is a deep secondary development version based on SweetCheckout. The original plugin uses the AGPL-3.0 open-source license, allowing free modification and distribution; this plugin also strictly complies with and adopts the AGPL-3.0 open-source license.

• Original Project: GitHub - SweetCheckout
• ❤️ Special Thanks: Special thanks to the original author MrXiaoM for providing a high-quality open-source foundation and excellent design concepts. Although this project has undergone significant rewriting and modifications in functionality, it is thanks to the original author's open-source spirit that this project was made possible!

---

More Information

• License: AGPL-3.0
• Official Wiki: https://docs.akihito.dpdns.org/category/webshopx-payments
• GitHub: https://github.com/Prism-Committee/WebShopX-Payments
• QQ Group:
• Discord Community:
• Disclaimer & Terms of Use: Click here

---

WebShopX-Payments：WebShopX 的支付插件

WebShopX-Payments 负责把现实中的支付接入到 WebShopX

快捷链接

---

主要功能

WebShopX-Payments（又称 WSXPay）是 WebShopX 的支付 Provider（底层服务提供者）插件。它将现实中的货币支付与 Minecraft 服务器（WebShopX）无缝连接。

• WebShopX：负责核心业务，包括玩家账户余额、充值订单管理、商品展示与购买逻辑、兑换码以及发货（玩家领取/充值命令执行）。
• WebShopX-Payments：专注于支付链路本身，包括请求内嵌支付后端创建支付、轮询/接收回调支付状态、匹配 Hook 收款通知，最终将成功的支付状态上报回 WebShopX。

📌 部署前提：这是一个可选前置插件，必须与 WebShopX 核心插件配合使用。它自身不处理商品与发货逻辑，单独安装将不会实现任何业务功能。

---

支持的支付方式

本页汇总 WebShopX-Payments 当前支持或已实现的支付方案，便于你快速评估可用性与接入优先级。

| 状态 | 平台 | 方案 | 说明 |
| :--- | :--- | :--- | :--- |
| 🟢 | 支付宝 | 订单码支付 | 官方接口。由服务端调用官方 API 生成动态支付二维码，用户扫码完成付款。 |
| 🔵 | 微信支付 | Native 支付 | 官方接口。标准扫码支付模式。系统生成二维码，用户扫码后拉起标准微信收银台。 |
| 🟢 | PayPal | REST API v2 | 官方接口。调用 PayPal 官方订单 API，动态生成支付审批链接或二维码。 |
| 🟡 | MercadoPago | Pro Checkout | 官方接口。MercadoPago 官方接口。 |
| 🟢 | Stripe | Checkout / Elements | 官方接口。已接入其标准 Web 支付流，支持多币种及各类国际信用卡。 |
| 🔵 | 支付宝 | 免签 Hook | 第三方方案。后端配置固定金额收款码，通过 Hook 截取开放平台的交易通知或账单信息，实现免签自动化回调。 |
| 🔵 | 微信支付 | 免签 Hook | 第三方方案。后端配置固定金额收款码，通过 Hook 截取微信 PC 端的实时收款通知，由后端匹配金额并确认付款。 |

• 🟢 完整验证：方案可行。开发人员已完成全流程的闭环测试，确认功能正常。
• 🔵 间接验证：方案可行。已有其他人员测试并成功反馈，但开发人员未亲自验证。
• 🟡 待验证：代码已实现。因开发人员缺少相关接口权限/凭证，暂未进行实际测试。

---

快速开始

1. 将 WebShopX-Payments.jar 放入服务器的 plugins 文件夹中。
2. 重启服务器，以生成默认配置文件。
3. 打开 plugins/WebShopX-Payments/ 目录修改配置文件，参照 官方Wiki 配置您所需的支付接口参数。
4. 重启服务器。
5. 在 WebShopX 的 admin.html 页面勾选识别到的支付方式。

---

游戏内命令

| 命令 | 说明 |
| :--- | :--- |
| /wsxpay help | 查看帮助 |
| /wsxpay reload | 重载配置 |
| /wsxpay status | 查看插件当前状态 |

---

适用场景

• 正在使用 WebShopX，并希望接入多种支付方式
• 希望接入现实的支付方式

---

📌 关于二次开发与版权说明

本插件为基于 SweetCheckout 的深度二次开发版本。原插件采用 AGPL-3.0 开源协议，允许自由修改与分发；本插件亦严格遵守并采用 AGPL-3.0 开源协议。

• 原项目地址：GitHub - SweetCheckout
• ❤️ 特别致谢：在此特别感谢原作者 MrXiaoM。感谢其提供的高质量开源基础与优秀的设计思路。虽然本项目在功能上进行了大幅度重构与魔改，但正是得益于原作者的开源精神，才让本项目得以诞生！

---

更多信息

• 开源协议：AGPL-3.0
• 官方Wiki：https://docs.akihito.dpdns.org/category/webshopx-payments
• GitHub：https://github.com/Prism-Committee/WebShopX-Payments
• QQ 交流群：
• Discord 社区：
• 免责声明与使用条款：点击跳转