返回

VibeFox Autopay for WooCommerce — 帮助

系统要求

WordPress:6.0 或更高版本。

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

PHP:8.0 或更高版本。

Autopay 服务:您需要 Autopay 服务的 Service ID 和 Shared key(哈希密钥)。它们显示在 Autopay 商户后台中:正式环境为 portal.autopay.eu,测试环境为 testportal.autopay.eu。测试服务有独立的 Service ID 和 Shared key,请向 Autopay 申请开通。该服务的哈希函数必须为 SHA-256。

币种:店铺币种须为 PLN、EUR、GBP、USD 或 CZK,并且您的 Autopay 服务须接受该币种。

可访问的店铺:Autopay 必须能够向您的店铺发送通知,因此店铺须可从互联网访问,不得处于维护模式,也不得有基本认证或拦截 POST 请求的防火墙。

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

安装

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

2. 点击 Activate。

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

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

5. 输入 Service ID 和 Shared key(测试与正式环境),并选择您服务所使用的币种。

6. 在 Autopay 后台为您的服务设置 ITN URL、返回地址以及 SHA-256 哈希函数(参见「配置」)。

7. 开启 Enable/Disable。在测试模式下完成一笔测试订单,然后取消勾选 Test mode 以接收真实付款。

配置

所有设置位于同一页面:WooCommerce > Settings > Payments > Autopay。页面字段上方会在所选环境的 Service ID 或 Shared key 为空,或店铺币种未在 Currencies 中选中时给出警告。在这两种情况下,该付款方式都会在结账时隐藏。在付款方式列表中,在所选环境填写凭据之前,Autopay 会被标记为需要设置。

常规

Enable/Disable: Enable Autopay payment gateway 用于开启或关闭该付款方式。默认:关闭。

Title: 顾客在结账时看到的付款方式名称。默认:Autopay。

Description: 结账时付款方式下方显示的文字。默认:Pay online by bank transfer, BLIK or card. You will be redirected to the secure Autopay payment page。

Autopay 服务

Service ID 和 Shared key 显示在 Autopay 商户后台(portal.autopay.eu 或 testportal.autopay.eu)中。

Test mode: Use the Autopay test environment (testpay.autopay.eu) and the test credentials below。默认:开启。关闭后,将使用正式凭据在 pay.autopay.eu 上接收真实付款。

Service ID (production): 来自 portal.autopay.eu 的数字格式服务标识。

Shared key (production): 正式服务的哈希密钥。请妥善保密。

Service ID (test): 来自 testportal.autopay.eu 的数字格式服务标识。

Shared key (test): 测试服务的哈希密钥。

Currencies: 您的 Autopay 服务所接受的币种:PLN、EUR、GBP、USD、CZK。Autopay 通常为每种币种单独开通一项服务。只有在此处选中订单币种时,才会提供该付款方式。默认:PLN。

付款通知(ITN)和返回地址

请在 Autopay 后台为您的服务(正式环境和测试环境)填写以下地址。具体地址显示在本设置区块中。

ITN (transaction notification) URL: https://your-site/?wc-api=wc_ap_payment
Return URL (after payment): https://your-site/?wc-api=wc_ap_return

若未设置 ITN URL,订单将永远不会被标记为已付款。每条 ITN 都会使用对应服务的 Shared key 所生成的 SHA-256 哈希进行校验。没有有效哈希或 Service ID 未知的通知会被拒绝。只有当订单的付款是通过同一 Autopay 服务发起时,通知才会应用于该订单。在您切换 Test mode 之前发起的付款,其通知仍会使用正确的密钥进行校验。

插件在 ITN 中处理以下付款状态:

SUCCESS: 付款已完成;经金额和币种核对后,订单将被标记为已付款。
PENDING: 付款已发起;添加备注。
FAILURE: 付款失败;等待中的订单变为失败。

高级

Logging: 将 Log payment events 写入 WooCommerce > Status > Logs,来源为 wcp_autopay_payment。密钥和顾客数据绝不会被记录。默认:关闭。

结账

顾客选择付款方式(默认为 Autopay)并下单。下一页会显示 Thank you for your order. You are being redirected to Autopay to complete the payment.,并将顾客转到 Autopay 付款页面。若顾客通过浏览器的后退按钮返回,页面会显示 Pay with Autopay 按钮,而不会再次自动跳转。

插件会传递以订单币种计的订单总额、作为描述的订单号(Order 加编号)以及顾客的账单电子邮件地址。在 Autopay 页面上,顾客选择付款方式并完成付款。

付款后,顾客会返回订单已收到页面。返回地址经过签名,但绝不会更改订单状态。只有当 Autopay 通过签名的 ITN 确认付款,且金额和币种与订单相符时,订单才会被标记为已付款。

若付款失败,订单将变为失败,顾客可通过 Pay 链接从该订单重新付款。若无法发起付款,顾客会看到简短提示,例如 Autopay payments are not configured. Please choose another payment method or contact the store.,或提示 Autopay 无法接受该币种的付款。

该付款方式支持经典结账、结账区块以及 Pay for order 页面。兼容 WooCommerce 高性能订单存储(HPOS)。

插件不支持从 WooCommerce 退款、订阅或定期付款,不保存银行卡(1-Click),结账页面上没有 BLIK 验证码或银行卡表单,也不能在结账页面选择银行或付款渠道;每个环境使用一个 Service ID。

订单

订单状态

Pending payment: 顾客已被转到 Autopay,但 Autopay 尚未确认付款。

Processing or Completed: Autopay 已确认付款。WooCommerce 会将订单设为处理中;仅含虚拟可下载商品的订单则设为已完成。订单备注会显示金额、Autopay 交易和付款日期。交易 ID 即为 Autopay 交易 ID(RemoteID)。

On hold: Autopay 报告的金额或币种与订单总额不符。订单未被标记为已付款。请在 Autopay 后台核对该交易,并手动完成或退款。

Failed: 付款失败。顾客可从该订单重新付款。

已付款的订单绝不会因之后的失败通知而改变。若 Autopay 报告已付款订单又一次付款成功,备注会警告顾客可能重复付款。若通知针对的是通过其他 Autopay 服务发起的付款,则不会应用,备注会对此作出说明。

退款

不支持从 WooCommerce 退款。请在 Autopay 后台退款,然后在 WooCommerce 中以手动退款的方式记录。

许可证密钥

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

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

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

许可证到期后,插件仍可继续使用,但更新和支持需要续费。系统会在后台自动重新检查状态。

故障排除

结账时未显示 Autopay:请检查许可证是否有效、Enable/Disable 是否开启、所选环境是否已填写 Service ID 和 Shared key,以及店铺币种是否已在 Currencies 中选中。设置页面会在缺少其中任一项时显示警告。

付款已完成,但订单仍为待付款:Autopay 未送达 ITN,或店铺拒绝了该通知。请检查 Autopay 后台(正式或测试)中该服务是否已设置本设置区块显示的 ITN URL,哈希函数是否为 SHA-256,以及插件中的 Shared key 是否与该服务一致。另请确认店铺可从互联网访问。开启 Logging,并在 WooCommerce > Status > Logs 中查看来源为 wcp_autopay_payment 的日志。

日志显示 ITN rejected: invalid hash:Shared key 与服务不一致,或该服务的哈希函数不是 SHA-256。

日志显示该 Service ID 未配置:通知来自一项未在插件中填写 Service ID 的服务。

订单因金额不符备注而被设为保留:Autopay 报告的金额或币种与订单总额不符。请在 Autopay 后台核对该交易,并手动完成或退款。

备注显示通知未应用:该订单的付款并非通过此 Autopay 服务发起,例如正式订单收到了测试通知。请在 Autopay 后台核对该交易。

付款后顾客被带到首页:无法验证返回地址,例如因为插件中未填写 Service ID。订单状态不受影响,它以 ITN 为准。

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

卸载

停用插件会保留所有数据。要移除插件,请先停用,然后在 Plugins 页面将其删除。本插件的许可证密钥、许可证状态和网关设置都会被移除。插件没有保留设置的选项。现有订单保留其付款备注和交易 ID。

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