​
Notch Pay WooCommerce Plugin

The Notch Pay WooCommerce plugin allows you to accept payments on your WooCommerce store using various payment methods including Mobile Money, Cards, and Bank Transfers.

​
Installation

1

Download the Plugin

Download the Notch Pay WooCommerce plugin from the WordPress Plugin Directory or directly from your WordPress admin dashboard.

2

Install the Plugin

  1. Log in to your WordPress admin dashboard
  2. Go to Plugins > Add New
  3. Click Upload Plugin and select the downloaded zip file
  4. Click Install Now
  5. After installation, click Activate Plugin
3

Configure the Plugin

  1. Go to WooCommerce > Settings > Payments
  2. Find “Notch Pay” in the list of payment gateways
  3. Click Set up or toggle the switch to enable it
  4. Configure the gateway settings

​
Configuration

​
General Settings

​
Payment Options

​
Order Management

​
Checkout Experience

The plugin adds Notch Pay as a payment option at checkout:

​
Payment Flow

1

Customer Selects Notch Pay

At checkout, the customer selects Notch Pay as their payment method.

2

Customer Completes Order

The customer fills in their billing and shipping information and clicks “Place Order”.

3

Redirect to Payment Page

The customer is redirected to the Notch Pay checkout page to complete the payment.

4

Customer Selects Payment Method

On the Notch Pay checkout page, the customer selects their preferred payment method (Mobile Money, Card, etc.).

5

Customer Completes Payment

The customer completes the payment using their selected method.

6

Redirect Back to Store

After payment, the customer is redirected back to your store’s thank you page.

​
Webhooks

The plugin automatically sets up a webhook endpoint to receive notifications from Notch Pay:

https://your-store.com/wc-api/notchpay

Make sure to add this URL to your webhook endpoints in the Notch Pay dashboard.

​
Webhook Events

The plugin listens for the following webhook events:

payment.complete

Triggered when a payment is completed. The plugin updates the corresponding order status.

payment.failed

Triggered when a payment fails. The plugin updates the order status to “Failed”.

payment.canceled

Triggered when a payment is canceled. The plugin updates the order status to “Cancelled”.

payment.refunded

Triggered when a payment is refunded. The plugin updates the order status and creates a refund in WooCommerce.

​
Refunds

The plugin supports refunds directly from the WooCommerce order page:

1

Go to the Order

Navigate to WooCommerce > Orders and click on the order you want to refund.

2

Initiate Refund

Click the “Refund” button at the top of the order page.

3

Enter Refund Details

Enter the amount to refund and any refund reason.

4

Process Refund

Check the “Refund via Notch Pay” checkbox and click “Refund”.

​
Subscriptions

The plugin integrates with WooCommerce Subscriptions to support recurring payments:

​
Subscription Settings

​
Currency Conversion

The plugin supports automatic currency conversion if your store currency is different from the currencies supported by Notch Pay:

​
Customization

​
Custom CSS

You can customize the appearance of the Notch Pay checkout button by adding custom CSS to your theme:

/* Customize the Notch Pay checkout button */
.payment_method_notchpay label img {
    max-height: 40px;
}

.payment_box.payment_method_notchpay {
    background-color: #f9f9f9 !important;
}

​
Hooks and Filters

The plugin provides hooks and filters for developers to extend its functionality:

// Modify payment parameters before creating a payment
add_filter('wc_notchpay_payment_params', function($params, $order) {
    // Add custom metadata
    $params['metadata']['custom_field'] = 'custom_value';
    
    return $params;
}, 10, 2);

// Do something after a successful payment
add_action('wc_notchpay_payment_complete', function($order, $payment) {
    // Send a custom email
    $mailer = WC()->mailer();
    $mailer->emails['WC_Email_Customer_Processing_Order']->trigger($order->get_id());
}, 10, 2);

​
Multi-Currency Support

The plugin integrates with popular multi-currency plugins:

​
WPML

If you’re using WPML with the WooCommerce Multilingual module, the plugin will automatically use the correct currency based on the customer’s selected language.

​
Currency Switcher for WooCommerce

The plugin integrates with the Currency Switcher for WooCommerce plugin to support multiple currencies.

​
Troubleshooting

​
Frequently Asked Questions

WordPress Plugin

General WordPress integration

PHP SDK

PHP SDK documentation

API Reference

Complete API documentation