Skip to content

WooCommerce Remote Sync Balance

Documentation for the Plug and Pay WooCommerce Remote Sync Balance plugin.

Requirements

Technical Requirements

  • PHP: 8.1, 8.2, or 8.3
  • ionCube Loader: Required. For more details, check the ionCube Manual.
  • WooCommerce: 3.5 or higher
  • WP-CLI: Recommended for background product sync.

Store Setup Prerequisites

  • Balance API Credentials: An API Key and Secret provided by Balance.

Integrations

Sync Products periodically pulls product data (price, stock) from Balance into WooCommerce. Products must first be mapped manually in the admin before they are synced.

Sync Order pushes new WooCommerce orders to Balance automatically. It creates or looks up the customer in Balance by their personal ID, then submits the order with line items and shipping.

Technical Specification & Feature Support

FeatureSupported
HPOS✅
Sync Products✅
--Stock sync✅
--Price sync✅
--Force sync✅
--Product mapping table✅
Import Products❌
Sync Order✅
--Customer sync✅
--Personal ID checkout field✅
--Shipping line item✅
--Receivables account✅

WP-CLI Commands

Sync Products

# Pull latest price and stock from Balance into WooCommerce
wp balance sync

# Download the remote product list into the local mapping table
wp balance download-list

Cron Scheduling

Product sync is lightweight and can run frequently. A typical setup runs sync every 15 minutes via a system cron:

# /etc/cron.d/remote-sync-balance

# Sync price & stock every 15 minutes
*/15 * * * * www-data wp --path=/var/www/html balance sync