Skip to content
OMPAYOMPAY API Documentation

Steps to Follow

Follow the steps below to integrate WooCommerce with the OMPAY payment gateway.

Step 1: Install the Plugin

Section titled “Step 1: Install the Plugin”
  • Log in to your WordPress Dashboard.
  • From the left-hand menu, click “Plugins,” then select “Add New Plugin.”
  • Upload the plugin .zip file by clicking “Upload Plugin”, then click “Install Now”.
  • Once installation is complete, click “Activate Plugin”.

Download WooCommerce Plugin

Step 2: Generate WooCommerce API Keys

Section titled “Step 2: Generate WooCommerce API Keys”
  • In the WordPress Dashboard, navigate to “WooCommerce” > “Settings”.
  • Select the “Advanced” tab and click on “REST API” under the Page setup section.
  • Click on “Add Key” or “Create an API key”.
  • Provide a suitable Description, select a User, and set Permissions to Read/Write.
  • Click on “Generate API Key”.
  • Note down the generated Consumer Key and Consumer Secret.

Step 3: Configure Payment in OMPAY

Section titled “Step 3: Configure Payment in OMPAY”
  • Go to the OMPAY merchant portal and log in with your credentials.
  • Navigate to “Payment Gateway” > “Payment Checkout Page”.
  • Click the “Create” button and fill in the required details.
  • In the Plugin Selection, choose “WooCommerce”.
  • Enter the previously generated Consumer Key, Consumer Secret, and your Webhook URL.
  • Click “Create” to save the configuration.
  • Once created, click on “View” to retrieve the Client ID and Client Secret.

Step 4: Configure the Plugin in WooCommerce

Section titled “Step 4: Configure the Plugin in WooCommerce”
  • In the WordPress Dashboard, go to WooCommerce > Settings > Payments.
  • Enable the OMPAY WooCommerce plugin and click on “Manage”.
  • Enter the necessary details, including the Client ID and Client Secret obtained from the OMPAY merchant portal.
  • Click “Save Changes” to apply the settings.

Step 5: Set Up the Checkout Page

Section titled “Step 5: Set Up the Checkout Page”
  • From the WordPress Dashboard, go to Pages > All Pages.
  • Find the page titled “Checkout - Checkout Page” and click “Edit”.
  • In the editor, click the “+” (plus icon) at the top left to open the block menu.
  • In the sidebar, search for “Shortcode” and add the shortcode block to the page.
  • In the shortcode textbox, type: [woocommerce_checkout]
  • Click “Save” on the top right to publish the changes.

Go back to “All Pages” and click “View” under “Checkout - Checkout Page” to preview the checkout interface.