返回

VibeFox eWAY for WooCommerce — 帮助

系统要求

WordPress:6.0 或更高版本。

WooCommerce:8.0 或更高版本,已安装并启用。

PHP:8.0 或更高版本。

店铺币种:AUD、NZD、SGD、HKD 或 MYR。对于其他币种,结账时会隐藏该付款方式。订单以其自身币种扣款。

eWAY 账户:您需要一个开通了 Rapid API 权限的 eWAY 商户账户,以及其 Rapid API 密钥和密码,可在 MyeWAY 的 Settings, API Key 中获取。测试时,您需要一个 eWAY 沙盒账户及其自己的密钥和密码。沙盒与正式环境的密钥不同。无需在 eWAY 中进行任何设置:每笔付款都会发送返回网址。

VibeFox 许可证密钥:在 vibefox.net 购买。一个密钥只能用于一个域名。

安装

1. 在 WordPress 中进入 Plugins > Add New > Upload Plugin,选择插件的 ZIP 文件,然后点击 Install Now。您也可以通过 FTP 将 wcp_eway_payment_gateway 文件夹上传到 /wp-content/plugins/。

2. 点击 Activate。

3. 打开设置:WooCommerce > Settings > Payments > eWAY > Manage,或在插件页面点击插件名称下方的 Settings。

4. 在页面顶部的许可证区块中输入您的 VibeFox 许可证密钥,然后点击 Activate。

5. 输入您的沙盒 API 密钥和密码,保持 Sandbox Mode 开启,打开 Enable/Disable,然后使用 eWAY 测试卡 4444333322221111 下一笔测试订单。

6. 输入您的正式环境 API 密钥和密码,取消勾选 Sandbox Mode 并保存。

配置

所有设置都位于同一页面:WooCommerce > Settings > Payments > eWAY。在各字段上方,一个标识会显示当前模式:SANDBOX(付款发往 eWAY 沙盒,不会扣除真实款项)或 LIVE(使用正式环境 API 密钥处理真实付款)。当当前模式的 API 密钥或密码缺失时(此时该网关不会在结账时显示),以及店铺币种不受支持时,页面会给出提示。在付款方式列表中,在当前模式具备凭据之前,eWAY 会被标记为需要设置;在沙盒模式下,它会显示测试模式标识。

常规

Enable/Disable:Enable eWAY Payment Gateway 用于启用或禁用该付款方式。默认:关闭。

Title:顾客在结账时看到的付款方式名称。默认:Credit Card (eWAY)。

Description:结账时显示在付款方式下方的文字。默认:Pay securely using your credit card via eWAY. You will be redirected to the eWAY secure payment page.

API 凭据

Rapid API 密钥和密码位于 MyeWAY 的 Settings, API Key 中。eWAY 提供了正式环境和沙盒密钥的指南,本部分中附有链接。沙盒与正式环境使用不同的密钥。

Sandbox Mode:Enable sandbox (test) mode 会使用沙盒密钥将付款发送到 eWAY 沙盒。不会扣除真实款项。默认:开启。取消勾选即可使用正式环境密钥收取真实付款。

Live API Key:您的 eWAY 正式账户的 Rapid API 密钥。

Live API Password:您的 eWAY 正式账户的 Rapid API 密码。

Sandbox API Key:您的 eWAY 沙盒(partner/developer)账户的 Rapid API 密钥。

Sandbox API Password:您的 eWAY 沙盒账户的 Rapid API 密码。

订单

Order Status on Success:eWAY 确认付款后的订单状态。

Processing:WooCommerce 默认值(默认)。仅包含可下载虚拟商品的订单会变为 Completed。
Completed:每笔已付款订单都会直接变为 Completed,跳过 Processing(一次状态变更,一封邮件)。

高级

Debug log:Enable logging 会将 API 调用和付款结果写入 WooCommerce > Status > Logs,来源为 wcp_eway_payment_gateway。银行卡数据和密钥不会被记录。错误始终会被记录。默认:关闭。

Uninstall:Delete all plugin data on uninstall。勾选后,删除插件时会移除网关设置及其日志。订单上保存的付款参考信息会保留。默认:关闭。

结账

顾客选择付款方式(默认为 Credit Card (eWAY))并下单。插件会向 eWAY 请求一个付款页面,金额为订单总额,使用订单币种,并附带订单号作为发票参考以及顾客的账单信息,然后将顾客带到 eWAY 的 Responsive Shared Page。顾客在那里用银行卡付款。付款会立即扣款。

付款后,顾客返回您的店铺。插件不信任浏览器:它会以服务器对服务器的方式向 eWAY 查询为该订单创建的付款页面的结果。只有在 eWAY 确认且已批准的金额和币种与订单一致后,订单才会被标记为已付款。随后顾客会进入「订单已收到」页面。如果此时无法向 eWAY 查询,订单将保持「待付款」状态,页面会显示 We have not received the confirmation of your payment from eWAY yet. If you completed the payment, this order will be updated shortly — please do not pay again. 付款会在打开订单已收到页面时以及 WooCommerce 自动取消未付款订单之前再次核实。

如果付款被拒绝,顾客会返回结账页面(或 Pay for order 页面),并看到原因,例如 Your payment was declined: Insufficient funds. Please try again or use a different payment method. 如果顾客在 eWAY 页面点击 Cancel,插件会先向 eWAY 核实没有任何款项被扣除。随后,在结账时下的订单会被取消,而从 Pay for order 页面付款的订单则保持未付款状态。顾客会看到 You cancelled the payment on the eWAY page. Your order has not been paid — you can try again. 如果付款未完成,提示信息为 The payment was not completed. Please try again.

顾客可以为未付款的订单重新付款。订单的每个付款页面都会被跟踪,因此即使是通过较早的页面付款,也能被识别。如果 eWAY 无法创建付款页面,顾客会看到一条简短的提示,例如 Payment error: Unable to connect to eWAY. Please try again.

该付款方式适用于经典结账、结账区块和 Pay for order 页面,并兼容 WooCommerce 高性能订单存储(HPOS)。

eWAY 不会为 Shared Page 发送服务器对服务器的通知:结果是在顾客返回时以及上述核实过程中获取的。插件在您的网站上没有银行卡输入框,不支持保存银行卡或订阅,不支持仅授权后再扣款,也不会评估 Beagle 欺诈评分(被 eWAY 欺诈规则拦截的交易由 eWAY 自行拒绝)。

订单与退款

订单状态

Pending payment:顾客已被转到 eWAY,但尚未付款;或者尚无法从 eWAY 获取结果(订单备注会说明这一点)。

Processing or Completed:付款已获批准。状态遵循 Order Status on Success。订单备注会显示 eWAY 交易 ID、授权码和响应。订单的交易 ID 即为 eWAY 交易 ID。

On hold after payment:eWAY 批准的金额或币种与订单不一致(例如 Approved for partial amount,或在顾客打开付款页面后订单被修改),或付款是在订单被取消之后才获批准的。备注会对此进行说明。在订单已收到页面上,顾客会看到 Your payment was received and is being reviewed by the store. We will contact you if anything is needed. 请完成订单或退还付款。

Failed:eWAY 拒绝了付款。备注会显示 eWAY 代码及其含义。

Cancelled:顾客在结账下单后于 eWAY 页面取消,或者在 eWAY 确认未付款后,订单被您取消或因 WooCommerce 库存保留超时而取消。

如果对一笔已付款的订单又批准了第二笔付款,订单不会发生变化。备注会提示您在 MyeWAY 中退还该重复付款。

退款

打开订单,点击 Refund,输入金额,然后点击 Refund via Credit Card (eWAY)(该按钮使用付款方式的标题)。支持全额和部分退款。退款会在付款时所用的环境(沙盒或正式环境)中发送,因此该环境的 API 密钥和密码必须已设置。如果 eWAY 拒绝退款,WooCommerce 会显示 eWAY 代码,且不会记录任何退款。成功的退款会以 eWAY 退款交易 ID 添加到订单备注中。

在 MyeWAY 中所做的退款不会同步回 WooCommerce。如有需要,请在 WooCommerce 中创建手动退款,而不要使用 eWAY 退款按钮。

许可证密钥

本插件需要一个来自 vibefox.net 的 VibeFox 许可证密钥。许可证区块位于 WooCommerce > Settings > Payments > eWAY 的顶部。将密钥粘贴到 License key 中,然后点击 Activate。该区块会显示状态,例如许可证有效期截止日期以及您的域名。使用 Check now 可再次检查状态,使用 Change key 可输入另一个密钥,使用 Remove key 可将其从本站点移除。链接 Manage licenses and domains in your account 会打开您的 vibefox.net 账户。

一个密钥只能用于一个域名。从某个站点移除密钥并不会释放其域名名额。请在您的 vibefox.net 账户中释放该名额。

没有有效密钥时,顾客在结账时看不到 eWAY。如果仍然发起了付款,顾客会看到 This payment method is not available. Please choose another one. 已登录的店铺管理员仍能看到该付款方式,并标有 (unlicensed — visible to admins only),以便您在购买密钥之前进行设置和测试。插件页面和 WooCommerce 页面上会出现提醒。现有订单不受影响:已发起的付款仍会被确认,退款也照常进行。

许可证过期后,插件仍可继续工作,但更新和支持需要续费。状态会在后台自动重新检查。

故障排除

eWAY does not appear at checkout:请检查许可证是否有效、Enable/Disable 是否开启、当前模式的 API 密钥和密码是否已设置(沙盒模式下为沙盒字段,正式模式下为正式字段),以及店铺币种是否为 AUD、NZD、SGD、HKD 或 MYR。在 Pay for order 页面,会检查订单币种。

The payment went through, but the order stays Pending payment:顾客没有从 eWAY 返回,或者当时无法向 eWAY 查询。eWAY 不会为 Shared Page 发送通知。付款会在打开订单已收到页面时以及 WooCommerce 取消未付款订单之前再次核实。请在 MyeWAY 中核对该交易,并查看 WooCommerce > Status > Logs,来源为 wcp_eway_payment_gateway。

顾客看到提示 This payment method is temporarily unavailable:当前模式的 API 密钥或密码缺失,或 eWAY 拒绝了它们。请检查当前模式的凭据。

顾客看到提示 eWAY could not start the payment:eWAY 返回了错误代码,并显示在提示中。通常是账单信息无效。

顾客看到提示 We could not match this payment to an order:返回链接不属于本店铺的任何订单。如果顾客已被扣款,请在 MyeWAY 中查找该笔付款。

顾客看到提示 We could not confirm your payment with eWAY:无法核实付款结果。获取结果后订单会更新;顾客不应再次付款。

Order is On hold after payment:请阅读订单备注。批准的金额或币种与订单不符,或者付款是在订单被取消之后到达的。请完成订单或退还付款。

退款失败,并提示沙盒或正式模式相关信息:该订单是在该环境中付款的,而其 API 密钥和密码尚未设置。请输入后重试。

许可证区块显示错误:请按照区块中的提示操作。例如,如果该密钥已在其他域名上使用,请在您的 vibefox.net 账户中释放一个名额,然后点击 Check now。如果站点地址已更改,请点击 Check now,为新域名激活该密钥。如果无法连接许可证服务器,插件将依据最后一次已知的状态继续工作。

对于开发者,readme 中列出了 eway_p_supported_currencies 过滤器,适用于您的 eWAY 账户已开通更多币种的情况。

卸载

停用插件会保留所有数据。要移除它,请先停用,然后在 Plugins 页面将其删除。本插件的许可证密钥和许可证状态始终会被移除。只有在 Uninstall(Delete all plugin data on uninstall)已开启时,网关设置和日志才会被移除。否则,它们会保留,以便日后重新安装。订单上保存的付款参考信息始终会被保留。现有订单会保留其付款备注和交易 ID。

eWAY 是其各自所有者的商标。本插件与 eWAY 无关联,也未获得 eWAY 的认可。