VibeFox Moneris for WooCommerce — Help

Requirements

WordPress: 6.0 or later.

WooCommerce: 8.0 or later, installed and active. Without WooCommerce the plugin refuses to activate.

PHP: 8.0 or later.

Store currency: CAD for a Canadian Moneris account, USD for a legacy Moneris USA account. The gateway is shown only when the order currency matches the account.

HTTPS and PCI DSS: card numbers are entered on your checkout page and pass through your server. Live payments require HTTPS and PCI DSS SAQ D compliance. If you cannot meet that, use a hosted payment page solution instead.

Moneris account: you need the Store ID and API Token of your Moneris Gateway store from the Moneris Merchant Resource Center > Admin > Store Settings. For testing, the public Moneris test store is filled in by default. Test credentials and test cards are on the Moneris developer portal.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

1. In WordPress go to Plugins > Add New > Upload Plugin, choose the plugin ZIP file and click Install Now. You can also upload the wcp_moneris_gateway folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Payments > Moneris > Manage, or click Settings under the plugin name on the Plugins page.

4. Enter your VibeFox license key in the license block at the top of the page and click Activate.

5. Choose the account country and enter the Live Store ID and Live API Token. Test mode is on by default and uses the public test store (store5 / yesguy for Canada, monusqa002 / qatoken for the US).

6. Choose Purchase or Pre-Authorization and the card logos, then turn on Enable / Disable.

7. Place a test order with a Moneris test card, then untick Test mode.

Configuration

All settings are on one page: WooCommerce > Settings > Payments > Moneris. Above the fields the page shows Moneris gateway is in TEST MODE. No real charges will be made. while test mode is on. In live mode it warns you when the live fields contain Moneris test credentials (the gateway is then hidden at checkout) and when the site does not use HTTPS. It also warns you when the store currency is not the currency of the Moneris account; the gateway is then hidden at checkout.

General

Enable / Disable: Enable Moneris Gateway turns the payment method on or off. Default: off.

Title: the payment method title shown to the customer. Default: Credit card (Moneris). In test mode, (Test Mode) is added to the title at checkout.

Description: the text shown above the card fields at checkout. Default: Pay securely with your credit card.

Moneris account

Your Store ID and API Token are in the Moneris Merchant Resource Center under Admin > Store Settings. Test credentials and test cards are on the Moneris developer portal. The section links to both.

Moneris account country: Canadian accounts charge in CAD, US accounts in USD. The gateway is shown only when the order currency matches. Default: Canada (CAD).

Canada (CAD): a Moneris Canada account.

United States (USD, legacy Moneris USA accounts): a Moneris USA account.

Test mode: Enable test mode (Moneris QA gateway, test credentials, no real charges). Refunds, captures and voids are always sent to the environment the payment was made in. Customers see TEST MODE: use a Moneris test card, no real charges are made. above the card fields. Default: on.

Live Store ID: the production Store ID, for example monca01234.

Live API Token: the production API Token.

Test Store ID: the public Moneris test store: store5 (Canada) or monusqa002 (US). Default: store5.

Test API Token: the public test token: yesguy (Canada) or qatoken (US). Default: yesguy.

Payment

Transaction type: how the card is charged. Default: Purchase.

Purchase (charge immediately): the card is charged when the order is placed.

Pre-Authorization (capture later): the funds are only reserved and the order is put On hold. Capture them by setting the order to Processing or Completed, or with the order action Capture Moneris pre-authorization. Cancelling the order releases them.

Card logos: the card brand logos shown next to the payment method title: Visa, Mastercard, Discover, American Express, JCB. Accepted brands depend on your Moneris account. Default: Visa and Mastercard.

Advanced

Debug log: Log API requests and responses (card number, CVV, expiry and API token are masked). Errors are always logged. View the log in WooCommerce > Status > Logs, source wcp_moneris_gateway. Default: off.

Delete data on uninstall: Remove the gateway settings and logs when the plugin is deleted. Default: off.

Checkout

The customer chooses the payment method (by default Credit card (Moneris)) and enters the card number, expiry date and security code in the WooCommerce card form on your checkout page. When the order is placed, your server sends the card to Moneris for the order total and gets the result at once. There is no redirect and no webhook. The security code (CVD) is always sent, so the eFraud rules of your Moneris store still apply.

An approved payment is marked paid only when Moneris reports the transaction as complete and the processed amount equals the order total. The customer then goes to the order received page. With Pre-Authorization the order is put On hold until you capture the funds.

If the card is declined, the customer sees Your card was declined with the reason from Moneris and can check the card details or use another card. If Moneris could not process the request (for example a wrong Store ID or API Token), the customer sees The payment could not be processed. Please try again or use another payment method. The reason is added to the order notes and the log. A second click while a payment is being processed shows A payment for this order is already being processed. Please wait a moment and check your order status before trying again. A paid or pre-authorized order is never charged again.

If Moneris does not answer (network error or timeout), the plugin sends a Status Check to Moneris to find out whether the transaction went through. If that is not possible either, the order is put On hold with the Moneris order ID, and the customer is not invited to pay a second time.

The payment method works on the classic checkout, on the Checkout block and on the Pay for order page. It is compatible with WooCommerce High-Performance Order Storage (HPOS).

The plugin has no saved cards or Moneris Vault, no WooCommerce Subscriptions, no Apple Pay, Google Pay or Interac Online, no Moneris Checkout or Hosted Tokenization, no 3-D Secure, AVS or Kount and no multi-currency pricing.

Orders and refunds

Order statuses

Pending payment: the order was created and the card has not been charged yet, for example after a declined attempt. The order note shows the Moneris code and message. The customer can pay again.

Processing: the purchase was approved. Orders with only virtual downloadable products become Completed, the WooCommerce default. The order note shows the amount, the Moneris transaction ID and the receipt. The transaction ID is the Moneris transaction number.

On hold: a pre-authorization was approved and waits for capture, the processed amount differed from the order total, or Moneris did not confirm the result. The order note explains it.

Cancelled: for a pre-authorized order, cancelling releases the reserved funds (void).

Capture and void

To capture a pre-authorization, change the order status to Processing or Completed, or choose Capture Moneris pre-authorization in the order actions. The current order total, minus refunds, is captured; it cannot exceed the authorized amount. If Moneris refuses the capture, the status is set back to On hold with a note and no processing or completed e-mail is sent. Moneris pre-authorizations expire after a few days, so capture them in time.

To release the funds, cancel the order or choose Void Moneris pre-authorization (cancel order) in the order actions. Setting the order to Refunded also releases an open pre-authorization. If the release fails, a note asks you to release it in the Merchant Resource Center.

Refunds

Open the order, click Refund, enter the amount and click Refund via Credit card (Moneris) (the button shows your Title). Full and partial refunds are supported. A pre-authorization can be refunded only after it was captured; before that, cancel the order to release the funds. The refund is sent to the environment and account the payment was made in, so that mode's credentials must still be filled in. If Moneris does not accept the refund, WooCommerce shows Refund failed with the reason and no refund is recorded. A successful refund is added to the order notes with the Moneris transaction ID.

License key

The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Payments > Moneris. Paste the key into License key and click Activate. The block shows the status, for example the date the license is active until and your domain. Use Check now to check the status again, Change key to enter another key and Remove key to remove it from this site. The link Manage licenses and domains in your account opens your vibefox.net account.

One key works on one domain. Removing the key from a site does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Moneris is not shown to customers at checkout. If a payment is started anyway, the customer sees This payment method is not available. Please choose another one. Logged-in store managers still see the payment method, marked (unlicensed — visible to admins only), so you can set up and test the plugin before you buy a key. A reminder appears on the Plugins page and on WooCommerce pages. Existing orders are not affected: captures, voids and refunds work.

When a license expires, the plugin keeps working, but updates and support need a renewal. The status is checked again automatically in the background.

Troubleshooting

Moneris does not appear at checkout: check that the license is active, Enable / Disable is on and the current mode has a Store ID and API Token. In live mode the live fields must contain your production credentials, not Moneris test credentials. Check that the store currency (or the order currency on the Pay for order page) is the account currency: CAD for Canada, USD for a US account. The settings page shows a warning when the currency does not match.

The payment went through, but the order stays Pending payment or On hold: the plugin has no webhook; the result comes only from the Moneris answer. If the order is On hold with a note that Moneris did not confirm the result, Moneris did not answer and the Status Check failed too. Look up the Moneris order ID from the note in the Merchant Resource Center: if the transaction is there, ship the order (and refund it there if needed); if not, cancel the order or ask the customer to pay again.

The customer sees Payment gateway is misconfigured. Please contact the store administrator.: the credentials of the current mode are missing, or live mode is on with Moneris test credentials in the live fields. Enter your production Store ID and API Token.

The customer sees This payment method does not support the order currency.: the order currency is not the Moneris account currency.

The customer sees an error when paying: open the order notes or turn on Debug log and look at WooCommerce > Status > Logs, source wcp_moneris_gateway.

Capture fails: the order has no pre-authorization waiting for capture, the order total is zero, or the amount is higher than the authorized amount. Moneris pre-authorizations also expire after a few days.

Refund, capture or void fails with a message about the mode or account: the payment was made in test or live mode, and the credentials of that mode are not set, or the payment was made with a Moneris account of the other country. Enter the credentials, or process the payment in the Merchant Resource Center.

Card-testing attacks: direct card forms are a target for card testing. Enable the WooCommerce checkout rate limiting and a CAPTCHA plugin, and the eFraud or velocity rules in your Moneris account.

The license block shows an error: follow the message in the block. For example, if the key is already used on another domain, free a slot in your vibefox.net account and click Check now. If the site address changed, click Check now to activate the key for the new domain. If the license server cannot be reached, the plugin keeps working on the last known status.

Uninstall

Deactivating the plugin keeps all data. To remove it, deactivate and delete it on the Plugins page. The license key and license status of this plugin are always removed. The gateway settings and the logs are removed only if Delete data on uninstall was on. Otherwise they stay for a later re-install. Existing orders keep their payment notes and transaction IDs.

Moneris is a trademark of its respective owner. This plugin is not affiliated with or endorsed by Moneris.