返回

VibeFox CCAvenue for WooCommerce — 帮助

系统要求

WordPress:5.8 或更高版本。

WooCommerce:6.0 或更高版本,已安装并启用。未安装时插件无法激活。

PHP:8.0 或更高版本,并启用 OpenSSL 扩展(用于加密请求和解密响应)。

CCAvenue 账户:您需要一个 CCAvenue 商户账户,并持有 Merchant ID、Access Code 和 Working Key。Access Code 和 Working Key 是针对某个网站域名签发的,因此请为本店铺的域名生成。测试环境使用相同的凭据;测试访问需由 CCAvenue 为您的账户开通。本插件使用 CCAvenue 印度端点。

币种:订单币种会按原样发送给 CCAvenue。CCAvenue 账户默认接受 INR;其他币种需要在您的 CCAvenue 账户中启用多币种处理。

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

安装

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

2. 点击 Activate。

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

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

5. 从您的 CCAvenue 后台输入 Merchant ID、Access Code 和 Working Key,然后开启 Enable/Disable。

6. 测试期间请保持 Test mode 开启,之后关闭即可接收真实付款。

配置

所有设置位于同一页面:WooCommerce > Settings > Payments > CCAvenue。字段上方,若已启用 CCAvenue 但缺少 Merchant ID、Access Code 或 Working Key,页面会发出警告(在三项全部填写之前,该付款方式在结账时隐藏);测试模式开启时,页面会显示 CCAvenue test mode is on: customers are sent to test.ccavenue.com and no real money is taken.;店铺币种不是 INR 时,还会提醒您注意多币种处理。

常规

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

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

Description: 结账时付款方式下方显示的文字。默认:Pay securely via Credit/Debit card, Net Banking, UPI or Wallet through CCAvenue。

API 凭据

登录 CCAvenue 商户后台(M.A.R.S.),打开 Settings > API Keys。为本店铺的域名生成 Access Code 和 Working Key。保存时会去除凭据中的空格。

Merchant ID: 您的数字型 CCAvenue Merchant ID。若包含数字以外的字符,保存时将显示错误,并保留之前保存的值。

Access Code: 本网站的 Access Code。

Working Key: 本网站的 Working Key(加密密钥)。它用于加密付款请求,也是验证 CCAvenue 响应的唯一方式,因此请妥善保密。

Test mode: Send customers to the CCAvenue test environment (test.ccavenue.com)。CCAvenue 对测试和正式环境使用相同的 Merchant ID、Access Code 和 Working Key;测试访问需由 CCAvenue 为您的账户开通。测试模式下,结账页面会显示 TEST MODE: no real transactions will be processed.。默认:开启。正式付款时请关闭。

返回 URL

CCAvenue 会将顾客返回到本节显示的地址。该地址形如 https://your-site/wc-api/ccavenue_p_callback/。插件会随每笔付款发送该 URL,因此无需在 CCAvenue 中进行任何设置。该地址必须属于在 CCAvenue 登记的域名。

高级

Debug log: Log CCAvenue events 会将订单号、CCAvenue 参考号和状态写入 WooCommerce > Status > Logs,来源为 wcp_ccavenue_payment。密钥、银行卡数据和地址不会被记录。默认:关闭。

Delete data on uninstall: Remove the plugin settings, logs and CCAvenue order references when the plugin is deleted。停用插件绝不会删除任何数据。默认:关闭。

结账

顾客选择付款方式(默认为 CCAvenue)并下单。Pay for order 页面会显示 Thank you for your order. You are being redirected to CCAvenue to complete the payment.,并将顾客转到 CCAvenue 付款页面。若浏览器未启用 JavaScript,顾客需点击 Pay via CCAvenue 或 Cancel order。每次尝试都会获得新的 CCAvenue 订单参考号。订单总额和币种、账单与配送信息以及订单密钥都会在加密请求中发送。姓名和地址会被处理为 CCAvenue 可接受的字符和长度;国家和州以名称形式发送,电话号码仅保留数字。

付款后,CCAvenue 会以加密响应将顾客返回。只有在 CCAvenue 确认后,订单才会被标记为已付款:响应必须能用您的 Working Key 解密,属于该订单,并且金额和币种与订单一致。随后顾客会进入订单已接收页面。

若付款失败,顾客会返回结账页面,并显示 Payment was not completed. Please try again or choose a different payment method.。若顾客在 CCAvenue 页面取消,提示为 Payment was cancelled. You may try again.。若无法验证响应,提示为 We could not confirm the payment result. If your account was charged, please contact us before paying again. 顾客可以为未付款的订单重新付款,例如通过 Pay for order 页面。若付款是从 Pay for order 页面发起且购物车为空,WooCommerce 会在购物车页面显示提示;失败的订单可通过 My account > Orders 重新付款。

该付款方式支持经典结账、结账区块以及 Pay for order 页面。兼容 WooCommerce 高性能订单存储(HPOS)。面向顾客的文字已提供印地语翻译。

结果仅取自顾客从 CCAvenue 返回时的数据:不存在服务器对服务器的通知,也不进行状态查询。若顾客在返回前关闭了浏览器,订单将保持为待付款。本插件不支持从 WooCommerce 退款,不支持保存银行卡、订阅或定期付款,不支持 iframe 或站内银行卡表单,也不支持 CCAvenue UAE 或其他地区性平台。

订单

订单状态

Pending payment: 顾客已被转到 CCAvenue,但尚未返回。若顾客一直未返回,请在 CCAvenue 后台核对该笔付款。

Processing: 付款已确认(仅包含虚拟可下载商品的订单会变为已完成,即 WooCommerce 默认行为)。订单备注会显示银行参考号、CCAvenue 跟踪 ID 和付款模式。订单的交易 ID 即为 CCAvenue 跟踪 ID。

On hold, amount/currency mismatch: CCAvenue 确认的付款金额或币种与订单不符,例如顾客开始付款后订单被修改,或应用了 CCAvenue 优惠折扣。备注会显示实收金额和应付金额。请在 CCAvenue 后台核对该笔付款,然后完成订单或退款。

On hold, awaiting bank confirmation: CCAvenue 将该付款报告为 Awaited。在款项仍可能被扣收的情况下,订单绝不会被标记为失败。请在处理订单前,先在 CCAvenue 后台核实,并手动更改状态。之后使用相同跟踪 ID 收到的响应仍会被应用。

On hold, payment for a cancelled order: 顾客在订单已取消后才完成付款。请检查库存,然后处理订单或退款。

Cancelled: 顾客在 CCAvenue 页面中止了付款。

Failed: 付款失败,或 CCAvenue 返回 Invalid、Timeout 或其他未成功的状态。备注会显示 CCAvenue 的提示信息。迟到的失败绝不会改变已付款订单。

若同一订单已付款后又收到另一笔付款成功的结果(例如来自两个浏览器标签页),订单不会再次被更改。备注会提示您在 CCAvenue 后台办理重复付款的退款。

退款:不支持从 WooCommerce 退款。请在 CCAvenue 后台退款,并在 WooCommerce 中手动记录。

许可证密钥

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

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

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

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

故障排除

结账时未显示 CCAvenue:请检查许可证是否有效、Enable/Disable 是否开启,以及三项凭据是否全部填写:Merchant ID、Access Code 和 Working Key。缺少其中任何一项时,设置页面会显示警告。

付款已完成,但订单仍为待付款:顾客没有从 CCAvenue 返回您的店铺,例如浏览器被关闭。本插件没有服务器对服务器的通知。请在 CCAvenue 后台核对该笔付款,并手动更新订单。

每笔付款都显示 We could not confirm the payment result:响应无法解密。Working Key 有误、属于其他域名,或复制时包含了多余字符。请为本店铺的域名重新生成密钥,并再次粘贴。请开启 Debug log,并查看 WooCommerce > Status > Logs 中来源为 wcp_ccavenue_payment 的日志。

CCAvenue 在付款页面之前显示错误:请检查 Access Code 和 Working Key 是否为本域名生成,返回 URL 是否属于在 CCAvenue 登记的域名,以及在测试模式下 CCAvenue 是否已为您的账户开通测试访问。若币种不是 INR,则必须在您的 CCAvenue 账户中启用多币种处理。

顾客看到 This payment method is temporarily unavailable:缺少某项凭据。

顾客看到 Payment gateway error: encryption failed:请求无法加密。请检查是否已安装 PHP OpenSSL 扩展。

付款后订单为保留状态:请阅读订单备注。已付金额或币种与订单不符,付款正在等待银行确认,或订单已被取消。请在 CCAvenue 后台核实该笔付款,然后处理订单或对该付款退款。

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

对于开发人员,自述文件列出了过滤器 ccavenue_p_request_params(用于更改发送给 CCAvenue 的数据,例如 merchant_param2 至 merchant_param5 或 promo_code;请勿更改 amount、currency、order_id 或 merchant_param1),以及用于结账图标的过滤器 ccavenue_p_icon。

卸载

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

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