Documentation

Setup

Welcome to the Opayo Payment Gateway integration guide! This guide will walk you through setting up and integrating Opayo with WooCommerce. We’ll cover both the Opayo Form and Server integration methods supported by the plugin.

Pre-Setup Checklist

Before you begin, ensure you have the following:

• An active Opayo account – Make sure you’ve signed up and your account is active.
• Access to the WooCommerce backend – You’ll need admin access to install and configure the plugin.
• MyOpayo Credentials – This includes your Vendor Name, Username, and Password.
• An active plugin license key – Required to activate the plugin.

Accessing MyOpayo Environments

• Test Environment: Start with the Opayo test environment to safely simulate transactions.
• Live Environment: When you’re ready to go live, switch to the Opayo live environment.

Step 1: Install the Plugin and Activate Your License Key

To start, you’ll need to install the Opayo plugin and activate the license key. Once installed, you can choose between the Form or Server integration options based on your business needs:

• Form: A basic entry-level option that allows you to take payments.
• Server: This advanced option includes features such as tokenization (allowing customers to save card details) and the ability to accept payments on your website via an iframe on the order-pay URL.

In this guide, we will first walk through the Server option setup.

Setting Up the Server Integration

To set up the Server integration, follow these steps:

• Navigate to WooCommerce > Settings > Payments > AG Opayo Server. This will take you to the Plugin Settings page.

• Enter your Vendor Name. This is the name you use to log in to your MyOpayo account.

• Choose the transaction type for your payment gateway.
  You can select Authenticate to authorize and capture payments separately, or Payment to transfer the amount immediately after authorization.
• Enable Test Mode. It’s always recommended to use the Test Vendor Account and work in a staging environment before going live.
• Log in to your MyOpayo account.

• Whitelist your server IP address. Use a tool like Site24x7 to find your server’s IP address, then add the IP to the whitelist in your MyOpayo account with a subnet mask of 255.255.255.000.

• Perform a test payment to ensure everything is set up correctly before switching to the live environment.

Setting Up the Form Integration

Now, let’s set up the Form integration. This setup is similar to the Server option but requires a encryption password.

• Navigate to WooCommerce > Settings > Payments > AG Opayo Form.

• Enter your Vendor Name.

• Enter your Encryption Password. This can be found in your MySagepay/MyOpayo account.

• Choose your transaction type.
  You can select Authenticate for reserving funds for future payments or Payment for immediate fund transfers.
• Perform a test payment to confirm the setup is working correctly.

Customizing Your Payment Page Design

Opayo allows you to customize the design of your payment page to match your brand’s look and feel. To customize the page:

1. Go to the Settings tab in your Opayo back office.
2. Under Account Settings, click Edit to view available customization options.
3. Customize the template’s colours and design to match your store’s branding.

For a more unique design:

• Select the Custom Template option to apply a bespoke design.
• You’ll need to download the template files and work with your developer to customise these templates.

Final Step: Testing

Before switching to the live environment, thoroughly test your setup by performing multiple test transactions. Testing ensures everything is configured correctly and catches any potential issues.

1. Use Opayo’s Test Environment for these simulations.
2. Review the error logs if needed and troubleshoot any issues.
3. Once you’re confident that everything works properly, switch to the live environment (Don’t forget to use your LIVE account details) to begin processing real payments.

Troubleshooting & Support

If you encounter any issues during the setup process:

• Refer to the troubleshooting guide provided in the plugin documentation.
• Contact our support team for direct assistance. We’re committed to making your Opayo Payment Gateway integration smooth and seamless.

By following these steps, you’ll ensure a successful and secure payment gateway setup for your WooCommerce store. Happy selling!