WooCommerce (API) Getting started

  Last updated: 

  Unfortunately, the product documented here is currently only available in English.

 

  This plugin requires WooCommerce to work. Please install WooCommerce before proceeding.

  This plugin is not compatible with the FontAwesome Pro library. Please uninstall this from your configuration when installing our WooCommerce plugin.

  Testing

This plugin has been tested by Trust Payments to ensure compatibility with the latest WooCommerce installation version using the default Storefront theme, with the assumption that no other themes or plugins have been installed. Please be aware that when using our plugin alongside other third-party themes or plugins, it is your responsibility to ensure you thoroughly test your configuration to ensure correct operation.

We recommend setting up two instances of your WooCommerce store - one for staging and the other for processing live transactions - and configuring them in the same way. This will help you to perform tests before applying updates going forward.     Click here to learn more (link to external site).

 

  WordPress Repository (Recommended)

  1. Navigate to Plugins > Add New Plugin.
  2. Use the search field and enter "Trust Payments Gateway (3DS2)".
  3. Click the "Install Now" button to install the plugin.
  4. Click the "Activate" button or navigate to Plugins > Installed Plugins > Activate the Trust Payments gateway plugin.

  Manual Installation

  1. Navigate to Plugins > Add New Plugin > Upload Plugin.
  2. Select the Trust Payments Gateway for WooCommerce (3DS2) plugin file (trustpayments-gateway-3ds2.zip) from your computer.
  3. Upload the file.
  4. Click the "Activate" button or navigate to Plugins > Installed Plugins > Activate the Trust Payments gateway plugin.

 

Settings

To configure the Trust Payments API for WooCommerce plugin, navigate to WooCommerce > Settings >
Payments > Trust Payments Gateway (3DS2) in your website dashboard.

  When getting started, we recommend first setting up the plugin on your staging store by following the instructions below. Once you have completed testing, you can replicate much of this configuration on your production store.

You will need to change the following settings:

  • Enable/Disable
    This check box must be ticked to use the Trust Payments option on your checkout.
  • Enable/Disable Live Mode
    When testing on the staging store, you must ensure this check box is NOT ticked.
    When processing transactions on your production store, you must ensure this check box is ticked.
  • Enable/Disable Debug Log
    Enables/disables the display of debugging information for developers. The logs can be found in WooCommerce > Status > Logs.

      This must only be enabled on your staging store and not on the production store.
  • Title and Description
    These are used on the checkout page of WooCommerce to describe the Trust Payments gateway.
  • JWT Username
    Your JWT username, assigned by Trust Payments.
  • JWT Secret
    This is used to sign the JWT (JSON Web Token) for processing requests to the Trust Payments gateway.
  • Site Reference
    This is the site reference provided by Trust Payments. When you are first getting started, please enter your test site reference on your staging store. This will allow you to place orders with test card numbers to perform testing prior to going live.
  • WS Username
    This will be your WebServices username registered with Trust Payments.
  • WS Password
    This will be your WebServices password.
  • Enable Url Notification and Password
    These settings ensure the WooCommerce plugin is updated when transactions have been processed on your Trust Payments account. We explain this process below.

  • Auth Method
    The auth method is used to specify how a transaction is to be processed by the card issuer. There are two supported values: Pre or Final.

      The auth method value selected does not affect the settlement status of the transaction. Click here to learn more about the settlement process.

  • Disable saving new cards
    Disables the saved card feature. With this ticked, customers won’t be able to save any new cards, but they will still be able to use previously saved cards.
  • Disable save cards option
    Disables the saved card feature. With this ticked, customers won’t be able to save new cards, but also won’t be able to use or see previously saved cards.

  Saved cards are enabled by default.

Select “Save Settings” at the bottom of the page when done to confirm your settings.

woocommerce-guide-01.png
Click image to expand

 

Configure URL notifications

  The following steps only apply if using our API plug-in (rather than the plug-in that makes use of our hosted Payment Pages solution).

Follow the steps provided below to configure and enable URL notifications in MyST, to ensure the WooCommerce plugin is updated when transactions have been processed on your Trust Payments account. This updates the status of the order in WooCommerce from "Pending Payment" to "Processing" (virtual items are instead updated from "Pending Payment" to "Completed").

  1. First of all, you will need to sign in to your WordPress Admin Panel, and go to:
    Settings > Payments > Trust Payments for WooCommerce

  2. Tick the Enable Url Notification option and enter a new password into the Url Notification Password field. You will need to provide this to our Support Team in the next step to complete the setup.

      You are being prompted to enter a new password in this field. This will be different from your MyST user credentials.

    woocommerce-notification-1811-en-01.png

  3. Contact our Support Team and request that a URL notification is configured on your test site reference. You will need to provide the name of your site reference and the URL Notification Password provided above. Once they have confirmed that this step has been completed, the notification will be active and your plug-in will be ready for testing.

 

Next:   Processing transactions    

 


 

  Contacting Support

If you need assistance when configuring the settings described above, please contact our Support Team.

Was this article helpful?
0 out of 1 found this helpful