WooCommerce Integration

Breeze Payment Gateway for WooCommerce

Latest Version: 2.1.0

https://github.com/breeze-com/breeze-woocommerce-plugin/releases


Introduction

The Breeze Payment Gateway for WooCommerce provides seamless integration between your WooCommerce store and the Breeze payment platform. This plugin enables you to accept payments securely through Breeze's robust payment processing system, supporting multiple payment methods including crypto, Apple Pay, Google Pay, and traditional card payments.

Customers will be redirected to Breeze's secure payment page to complete their transactions, ensuring PCI compliance and enhanced security for your store.


Features

Full Breeze API integration with all core endpoints

Secure payment page redirects with SSL support

Webhook support for real-time payment notifications

Test mode and live mode support for safe development

Internationalization ready for global deployment

WooCommerce Blocks compatible for modern checkout experiences

Multiple payment methods including crypto, Apple Pay, Google Pay, and card payments


Requirements

Before installing the Breeze Payment Gateway, ensure your system meets the following requirements:

  • WordPress: 5.8 or higher
  • WooCommerce: 6.0 or higher
  • PHP: 7.4 or higher
  • SSL Certificate: Required for live payments
  • Breeze Account: Active account with API access

Installation

  1. Download the woocommerce-gateway-breeze plugin
  2. Upload the folder to /wp-content/plugins/
  3. Activate the plugin through the Plugins menu in WordPress
  4. Navigate to WooCommerce > Settings > Payments
  5. Enable Breeze Payment Gateway
  6. Click Manage to configure settings

Configuration

Accessing Settings

📘

Navigate to WooCommerce > Settings > Payments > Breeze Payment Gateway to access the configuration panel.

WooCommerce Payment Settings

General Settings

SettingDescription
Enable/DisableEnable or disable the Breeze Payment Gateway for your store
TitleThe title customers see during checkout (default: "Breeze Payment")
DescriptionPayment method description shown at checkout (default: "Pay securely using Breeze payment gateway.")

API Credentials

SettingDescription
Test ModeEnable to use test API credentials for development and testing. Disable for production
Test API KeyYour Breeze sandbox environment API key
Live API KeyYour Breeze production API key
Webhook SecretYour Webhook Secret Key for verifying webhooks with Breeze

Getting Your API Key

  1. Log in to your Breeze Dashboard
  2. Navigate to Developer > API Keys
  3. Generate a new API key
  4. Copy the key and paste it into the appropriate field (Test or Live) in your WooCommerce settings
  5. Add your Webhook call back url eg.
    https://yoursite.com/?wc-api=breeze_payment_gateway
  6. Copy the webhook secret key and paste into the webhook field
  7. Save your changes

Payment Method Preferences

The plugin supports configuring Preferred Payment Methods that will be displayed on the Breeze checkout page:

  • Crypto - Accept cryptocurrency payments
  • Apple Pay - Enable Apple Pay for iOS and macOS users
  • Google Pay - Enable Google Pay for Android users
  • Card (Manual Card Payment) - Accept credit/debit card payments

These preferences help streamline the checkout experience for your customers.

Debug Options

SettingDescription
Debug LogEnable logging for troubleshooting. Logs are saved to WooCommerce logs and can be accessed via WooCommerce > Status > Logs

When enabled, the plugin will log:

  • API requests and responses
  • Payment page creation events
  • Webhook notifications
  • Errors and exceptions
📘

Note: Debug logging should be disabled in production environments to avoid performance impacts and potential security concerns.


Refunds

Important Notice

Refunds must be processed manually through your Breeze dashboard.

Refund Process

  1. When attempting to refund through WooCommerce, a notification message will inform the admin to process the refund in Breeze
  2. Log in to your Breeze Dashboard
  3. Process the refund through Breeze's interface
  4. Update the order status in WooCommerce manually if needed

Internationalization

The plugin is translation-ready:

  1. Text Domain: breeze-payment-gateway
  2. POT File: languages/breeze-payment-gateway.pot

Testing

Follow these steps to test the plugin before going live:

Test Scenarios

Scenario 1: Sandbox Payment

  1. Add product to cart
  2. Proceed to checkout
  3. Select Breeze Payment
  4. Complete payment on Breeze page
  5. Verify redirect back to store
  6. Check order status is "Processing"
  7. Verify order in Breeze dashboard

Scenario 2: Production Payment

  1. Verify with Breeze all commercial requirements have been satisfied and you have a production account generated
  2. Disable Test Mode in plugin settings
  3. Add Live API Key from Breeze dashboard
  4. Disable Debug Log (optional, but recommended for performance)
  5. Save changes
  6. Place a small test order to verify live mode works
  7. Monitor initial orders closely

Support