Netbanx Checkout API Desjardins Gateway WooCommerce

This plugin allows you to use Netbanx – (Desjardins) Checkout API payment gateway within your WooCommerce store.

Checkout Option
  1. Upload the ‘woocommerce-gateway-netbanx-checkout-api‘ folder to the ‘/wp-content/plugins/‘ directory.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.
  3. Navigate to `WooCommerce > Settings > Payment Gateways > Netbanx Checkout` to configure the Netbanx – Checkout API gateway settings.
  4. For alternative installation using the WordPress Admin panel | Click Here
  5. If you need help on how to upload and activate a WordPress plugin click here.

Steps for configuration of your Netbanx installation.

  1. IMPORTANT: Please make sure you request to Netbanx to enable the return off the Cardholder name in the Transaction Response.Login to your WooCommerce store
  2. Enable/Disable Netbanx.
  3. If you are going to perform test payments Enable test mode
  4. Set your “Method Title” and “Description”. These options are seen on the checkout page.
  5. Enter your “Shop ID”
  6. Enter Netbanx “Shared Key”.
  7. Enter your “Merchant Account Number”, if needed. This field is optional, so leave empty, if you don’t need it.
  8. Enter the iFrame width and height value. You can measure the width and height according to your payment page.
  9. Enable “Debug Log”, if you want to get a log of the request and response steps and parameters.
  10. Save Changes.
  11. Recommended: make a few test payments before you go live. In live mode make a couple small live test payments, too.
  • Enable/Disable:
    • Enable Netbanx.
  • Sandbox:
    • ┬áThe option will turn on the sandbox feature of the gateway and enable you to make test payments.
  • Method Title:
    • This controls the title which the user sees during checkout.
  • Description:
    • This controls the description which the user sees during checkout.
  • Shop ID:
    • Shop ID provided by NETBANX and used as identification in requests sent to NETBANX.
  • Shared Key:
    • Shared Key provided by NETBANX and used to digitally sign requests sent to NETBANX.
  • Merchant Account Number:
    • This is the merchant account number. If you have more than one merchant account with the same currency, you must provide the Account Number, if not leave empty.

      Main Settings
  • Iframe Width:
    • Width of the iframe window. Enter only numbers in pixels (i.e. 700).
  • Iframe Height:
    • Height of the iframe window. Enter only numbers in pixels (i.e. 850).
  • Customer ID Prefix:
    • Enter here a prefix for the customer ID send to Netbanx. Because the customer ID is required to be unique, we will to enter a prefix for it, to make sure it will be. (Example: WooCommerce-)
  • Merchant’s website address (URL):
    • Please enter here your Merchant website url. Please enter the url together with the http:// ( Example: )
  • Payment Page Language:
    • Please select the language for your payment page.
  • Debug Log:
    • Debug log will provide you with most of the data and events generated by the payment process.

      Main Settings Cont.

Please visit the plugin changelog page for more information.

How to get more information about an error you received, when trying to checkout?

When trying to get support about an error message, please try to get the most information about it. Here is what you should do:

I – Collect the error message from Netbanx.

  1. Login to your Netbanx account
  2. Navigate to Reports > Activity Report > Make sure you select Checkout API > set the time that the error occurred
  3. Click Generate Summary
    Navigate to the requests summary


  4. In Valid Requests choose Profile Checkout, for payment request errors.

    Profile Checkout
  5. In Shops, choose WooCommerce
  6. When you reach the records, choose the error record and click the Conf. No. to open the error details

    Error Records
  7. In the error details you will have access to the request that netbanx received, the response, the error description and the error code. Open up a file and paste all the information in it.

    Error Details
  8. Now Save the file and attach it to the ticket email.

II – Generate a debug log:

  1. Enable Debug Log

    Enable Debug
  2. Perform a payment or at least attempt one.
  3. Copy the debug log and paste it in a file.
    Get The Debug Log


  4. Now Save the file and attach it to the ticket email.

Q: I tried to checkout, but I receive a “There was a problem trying to process your request.” on the checkout page, what should I do?

Checkout Error Message

A: Please get the more information about the error and file a ticket on support page.