WooCommerce

Last updated: October 30, 2026

Overview

Streamline your WooCommerce store’s transactions with our payment plugin, ensuring secure and efficient payment processing.

Our WooCommerce payment extension helps you launch or expand your business rapidly. If you are launching your business first time on WooCommerce, we can help you to quickly roll out through our configuration capabilities. If you are already on WooCommerce and thinking of expansion, we offer a wide variety of secure local and global payment options.

Our WooCommerce extension which is built on Payments Orchestration Platform delivers a competitive advantage over payment gateways including payment processing optimization and advanced analytics through a single integration. We help you manage payments across multiple P2Ps, acquirers and banks across all channels — online, mobile or recurring — using a strategic, streamlined approach.

Looking for the step-by-step journey (prepare, install, configure, test, go live)? See the WooCommerce overview on the Shop Plugins page. This page contains the detailed reference.

↑ Back to top


Compatibility

Our plugin supports the following versions:

  • Woocommerce - 9.1.2
  • Wordpress - 6.6.1

Important

It is strongly recommended that the plugin installation is first completed and validated in a non‑production environment (for example, a QA or staging environment) before proceeding with installation in production.

This plugin is designed to work with the out‑of‑the‑box (OOTB) native WooCommerce checkout.

If your store uses a custom checkout implementation or heavily modified checkout flow, additional customization by the merchant or their implementation partner (agency/integrator) may be required to ensure compatibility with the plugin.

↑ Back to top


Configure

You need the Entity ID, API key and webhook decryption key from the Onboard section.

Open the plugin settings

Navigate to the Payment Settings:

  1. Go to: WooCommerce >Settings >Payments.
  2. Click ‘Finish set up’ to see the configuration page for a specific payment method.

Figure 1: Open the plugin settings

WooCommerce: Open the plugin settings

Field reference

General Setting

Field Name in WooCommerce  Configuration Mandatory/Optional/ConditionalPossible ValuesComments
EnabledMandatoryEnabled or DisabledConfigure this to enable or disable the payment plugin
EnvironmentMandatoryTest or Live

Test - For test environment Configuration

Live - for Live environment Configuration

Entity ID (Test)MandatoryEntity ID of your Channel or Merchant from the Open Payment PlatformRefer to onboarding configuration.
 API Key (Test)MandatoryAPI of your Channel or Merchant from the Open Payment PlatformRefer to onboarding configuration.
Entity ID (Live)MandatoryEntity ID of your Channel or Merchant from the Open Payment PlatformRefer to onboarding configuration.
API Key (Live)MandatoryAPI of your Channel or Merchant from the Open Payment PlatformRefer to onboarding configuration.
Test ModeMandatoryINTERNAL or EXTERNAL 

Connector test mode 

  • EXTERNAL causes test transactions to be forwarded to the processor's test system for 'end-to-end' testing
  • INTERNAL causes transactions to be sent to our simulators.
Webhook URLMandatory
The value will be auto-populated to configure the webhook URL in Open Payment Platform
JavascriptConditional

Use this option to customize the payment widget, while using Google Pay, providing gatewayMerchantId is mandatory. 

window.wpwlOptions = {
style: "plain",
    googlePay: {
        gatewayMerchantId: "ValueOfYourEntityID",
    },
  };

Additional information - Advanced Options

Google Pay

CSSOptional
CSS helps to customize the default checkout payment page experience, possible examples, and options on Google Pay
Webhook Decryption KeyMandatory
Fill in the Secret for the encryption value generated during webhook endpoint creation in the Open Payment Platform.

Sample Configuration

Figure 2: Sample Configuration

WooCommerce: Sample Configuration

Please refer to the detailed installation and Configuration Guide.

↑ Back to top


Onboard

After plugin installation, please follow the instructions to configure the extension in WooCommerce and in Open Payment Platform using configuration details.

You will need to configure merchant accounts and brands in Open Payment Platform to work with checkout using plugins.

Credentials from the Open Payment Platform

To start processing with plugins, plugin configuration in the Open Payment Platform needs to be enabled for your PSP or merchant. Without this configuration, you won’t be able to send transaction requests from the plugin platform to the payment platform for processing.

Please contact your account manager or project team to enable plugin usage from the Open Payment Platform.

You will need the following information from the Open Payment Platform to configure and onboard with the payment plugin:

Field Name in WooCommerce Configuration Open Payment Platform Field NameMandatory/OptionalComments
Entity IDEntityIdMandatory

From the Merchant or Channel level, according to the Open Payment Platform configuration setting of Merchant accounts

In Open Payment Platform - Administration→ Account data

API KeyAccess TokenMandatory

From Open Payment Platform at the Merchant or Channel level, according to the Open Payment Platform configuration setting of Merchant accounts

In Open Payment Platform - Administration→ Account data → Merchant Info/Channel Info

Figure 3: Credentials from the Open Payment Platform

WooCommerce: Credentials from the Open Payment Platform

Webhook configuration

The webhooks are HTTP-based callbacks that notify your plugin platform of all the events you subscribed for on an entity. Instead of constantly polling for updates, a webhook is set up once and only sends data when a specific event occurs. The events can be about tokens, payments, payment schedules, risks, or any transaction state updates related to payments or transactions connected to a payment, it is necessary to configure webhooks for seamless communication and transaction updates. 

Merchant/PSP to configure webhooks and generate the webhook decryption key in the Open Payment Platform for
webhook handling.

Steps:

  1. Login to merchant dashboard (Open Payment Platform)
  2. Select your division (here OPP_Division)
  3. Go to Administration - Webhooks
  4. Click on the “Add New Webhook” button

Figure 4: Webhook configuration

WooCommerce: Webhook configuration

Follow further steps below to configure Webhook

  1. URL: Get the webhook URL from the plugin admin configuration page.
  2. Notification types: Select the notification types as required by the merchant
  3. Fields to include: Select the option as required by the merchant
  4. Secret for encryption: (Copy the value and add in the “Webhook Decryption Key” field under general settings in WooCommerce check Sample Configuration)
  5. Wrapper for encrypted notification: JSON
  6. Emails: Enter email IDs to receive a notification alert
  7. Save

Figure 5: Webhook configuration (continued)

WooCommerce: Webhook configuration (continued)

↑ Back to top


Features

Payment types

Payment TypeSupportedComments 
Authorization (PA)✔
Debit (DB)✔
Credit (CD)–

Capture (CP)

Full✔
Partial

✔


Multiple✔

Refund (RF)

Full✔
Partial✔
Multiple✔

Reversal (RV)

Full✔
Partial–
Multiple–
Receipt (RC)–
Rebill (RB)–

Note - Some functionalities available in the plugin might not be supported by the connector in use. Please refer to the respective connector integration sheet for details.

Features

We have standard plugin integration with WooCommerce using our Open Payment Platform Integration option, that give you access across all the features and uses the WestpayAPI to present payment options to your shoppers 

FeatureSupportedComments
Supported Brands✔

ALL

Note - VISA, Mastercard, Amex, PayPal, Klarna, Apple, and Google Pay are the brands certified internally, Plugin integration can adopt other card and APM brands, for any additional field support specific to APM or card please contact your account manager. 

Supported Payment Methods✔

Credit Card, Virtual Account

Countries✔ALL (if WooCommerce  is in countries)
Authorization Currencies✔ALL
Late Notification✔

Payment Facilitator

–Can be supported if the connector has its own configuration for PayFac
Recurring/Subscription ✔To be enabled in production on demand.
Reference ID✔
Timeout Autoreversal✔
TLS 1.2✔
Internal Tokenization
✔
Omni Tokenization–
External Tokenization–
Zero Authorization/ Account Verification–
Digital Wallet✔Apple Pay, GooglePay
3D Secure ✔Using our MPI
Airline Data–
Settlement Reporting–

Settlement reporting is as per the specific brand connector in use. 

WestpayAPI OneClick Checkout (Save Card)✔
WestpayAPI widget or full page redirect✔
Customization through standard WestpayAPI JS✔using wpwlOptions
Customization through standard WestpayAPI CSS✔using wpwlOptions
PayByLink–
Manage Saved Card in User Profile–
Download Audit Log✔Enable this through WooCommerce Support
Guest Checkout ✔
Transaction identifier ✔merchantTransactionID 
Fast Checkout✔Apple and Google Pay
Fraud with Payment✔
Standalone Fraud–
PCI DSS 4✔
Classic Checkout Layout✔The plugin only supports the classic checkout layout. 

↑ Back to top


Supported fields

As part of the integration with the plugin platform, we have integrated the following fields. Please note this is only informational; you don't need to worry about how to send these fields or integrate them. Plugin extension takes care of it. 

Note - the below fields are supported as standard, if any specific fields need to be supported for APM for the Card brand, please get in touch with your account manager. 

OPP Field NameComment
  entityId
  paymentType
  amount
  currency
  testMode
  merchantTransactionIdIn Subsequent Transaction.
  customer.givenName
  customer.surname
  customer.email
  billing.city
  billing.country
  billing.postcode
  billing.state
  billing.street1
 billing.street2
  shipping.city
  shipping.country
  shipping.postcode
  shipping.state
  shipping.street1
  shipping.street2
  cart.items[n].name
  cart.items[n].quantity
  cart.items[n].sku
  cart.items[n].price
  cart.items[n].totalAmount
  cart.items[n].currency
  cart.items[n].description
  shipping.customer.givenName
 shipping.customer.surname
 shipping.customer.email
 shipping.customer.mobile
shipping.method
registrations[0].id
'customer.phone'
customer.merchantCustomerId

↑ Back to top


Resources

↑ Back to top


See also