Refmora
Documentation

Track WooCommerce referrals, calculate product commissions and manage affiliate withdrawals.

Requirements

• WordPress 6.5+, PHP 7.4+ and WooCommerce 8.2+, as declared by this release.
• A configured WooCommerce My Account page, products and checkout. Free requires no license.
• For automatic payouts: eligible provider accounts, sufficient funds and OpenSSL AES-GCM support. Live Stripe onboarding requires HTTPS.

First setup

1. Install and activate Refmora with WooCommerce active. Use Plugins → Add New → Upload Plugin, or install its folder in wp-content/plugins/.
2. Free starts without activation. For optional premium features, install Refmora Pro separately, then open License and verify your key.
3. In Settings, enable the program, choose enrollment approval and commission rules.
4. Confirm the base currency under WooCommerce → Settings → General. Free commissions use only this base currency. Pro provides rates for different-currency orders.
5. Set the withdrawal minimum and active methods. Add bank transfer or mobile-wallet instructions for manual payouts.
6. Review Sharing, Emails and Customization; save each page. Apply cache exclusions.
7. Use a separate affiliate and buyer to test an order before launching.

Affiliates, commissions and withdrawals show 10 records per page. Search and filter by status inside each list card; pagination retains filters. Navigation badges show pending items. The WooCommerce submenu also shows pending affiliate applications.

Store actions require manage_woocommerce. Credentials, license actions and settings backups require administrator privileges. Custom CSS additionally requires unfiltered_html.

Terms content

Use the Affiliate Terms & Conditions editor at the end of Settings. Customers see the content and must accept it before joining. Empty content means no terms checkbox. Acceptance saves a terms version and time; later edits apply to new applications, not automatic re-enrollment of existing affiliates.

Turning approval on does not put existing approved affiliates back into Pending. Approved, unblocked accounts participate while the program is active.

Each affiliate has a personal token. A valid referral landing sets a signed browser cookie to attribute a later eligible purchase.

https://example.com/?refm_ref=AFFILIATE_TOKEN
https://example.com/product/example/?refm_ref=AFFILIATE_TOKEN

Counters and eligibility

• Clicks: daily aggregate counts. Consecutive clicks on the same referral count once per browser within 30 minutes, not once per unique person.
• Registered customers: new accounts registered while a valid referral cookie exists. This is not every order or existing customer who purchases.
• Self-referrals: an affiliate's own purchase does not earn commission.

The browser must retain the cookie and the landing request must reach WordPress. Cookies do not move between devices, browser profiles or separate private sessions.

Choose Percentage or Fixed per unit. Percentages accept 0–100%. Product-specific settings override the default. Commission uses product line totals after discounts, excluding tax and shipping.

Pending → Available

• Immediately after order completion (default): available when the order is Completed.
• After a waiting period: 1–365 days from order completion, not from the click or purchase time.

The availability date is saved when the order first completes. Later settings updates do not replace it; previously released earnings stay available. Action Scheduler or WordPress cron handles timed release. A paid order still in Processing remains Pending.

Refund handling

Refunds reduce eligible commission. An unsent changed reservation may be rejected so the affiliate can request the corrected balance. In-flight payments keep the original allocation. Refunds after settlement reduce future earnings and can create a negative adjustment.

Choose Affiliate commission: Use global setting, Percentage, Fixed per unit or No commission. Enter the relevant product rate/amount.

Parent product settings apply to all variations. History shows saved order-item titles and variation attributes with earning rate and quantity. Editing a catalog product does not retroactively replace saved order rates.

Products with commission disabled do not earn commission and are excluded from the top-selling recommendations.

WooCommerce is the currency source of truth. Refmora uses the stored base currency from WooCommerce → Settings → General. There is no independent Affiliate Area currency selector.

Different-currency orders need a rate into their saved commission currency. Currency and exchange-rate snapshots are saved with the order. Older transactions retain their original currency; changing the base currency does not automatically convert historical balances.

Manual rate format

One pair per line: FROM TO RATE. Up to 50 pairs. The inverse is derived automatically.

USD BDT 120

Example only: 1 USD = 120 BDT. This is not a current market quote; use your verified rate.

Recover a missing currency commission

1. Save valid exchange settings.
2. At the bottom of Settings, use Recover a missing currency commission.
3. Enter the WooCommerce order ID and click Recover commission.

The order must have saved affiliate attribution and no commission record. Historical rates are used when available; otherwise the current configured rate is saved. Paid/reserved records are never replaced. Recovery cannot assign an unattributed order to an affiliate.

Default address: /my-account/Refmora/. Customers use their WooCommerce login. Applicants see the invitation and join form; approved affiliates see their dashboard.

Commission, withdrawal and customer histories paginate after 10 items. Paused or blocked accounts can still see history.

Top selling products

Visible, eligible simple or variable products are ranked across the store by WooCommerce lifetime unit sales. Each has a copyable affiliate link. This is not the affiliate's own ranking; fewer than five appear if there are fewer eligible selling products.

Enable sharing and the product section separately. Customize the title and choose active icons: Facebook, WhatsApp, Telegram, X, LinkedIn and Copy link. Defaults: Facebook, WhatsApp and Copy link. Unsupported Messenger/TikTok direct-share actions are not shown.

The compact section appears after the standard product add-to-cart form. Approved affiliates see icon-only controls without a link box; copying gives a check/success indicator. Non-affiliates see a join link; other account states link to the Affiliate Area.

Generator

1. Find Affiliate link generator after Your referral link.
2. Paste a public product or page URL from the same store.
3. Click Generate link and copy the result.

Off-site and private/admin/checkout destinations are rejected. Active sharing and an approved account are required. Custom themes must render the product WooCommerce hook for the section to appear.

Set the minimum withdrawal and choose Enable payout → Enabled. Withdrawals paused stops new requests. Affiliates request their entire available balance after adjustments and can have one Pending, Approved or Processing request at a time.

Methods

Free includes manual payout methods; licensed Pro adds up to 20 manual methods with instructions and Active checkboxes: for example Bank transfer or bKash. One active method exposes the first active method only; manual methods are listed before automatic providers. Multiple active methods exposes all configured choices.

1. Affiliate selects a method and submits required destination details.
2. Earnings are reserved to prevent duplicate requests.
3. Manager approves or rejects under Withdrawals.
4. For manual methods, pay outside the plugin, then click Mark paid only after sending.
5. For automatic providers, approve and explicitly click Send payment or Run Sandbox payout. Approval alone sends nothing.

Uncertain responses keep funds reserved and reuse the original payment identity. Do not send an external duplicate while status is unknown. Processing requests cannot be manually released or marked paid. After the safe retry window, unknown sends require reconciliation rather than a new payment identity.

1. Use a verified PayPal Business account with Payouts access and sufficient balance. Live access must be granted by PayPal.
2. In PayPal Developer Dashboard → Apps & Credentials, open/create a Sandbox or Live REST API app.
3. Choose the matching environment in Refmora. Enter its Client ID and Client Secret in the shared fields.
4. Choose payout currency, enable automatic payouts and save. Authentication is checked without sending money.
5. Affiliates choose PayPal and enter their PayPal account email. Sandbox requires a Sandbox recipient account.
6. Approve a withdrawal, then explicitly run the Sandbox payout or send the Live payment.

Test and Live credentials are stored separately. Blank fields keep saved values for that environment. Currency conversion, amount and rate are frozen on the request.

A batch response alone does not mark earnings paid. The matching recipient item must be confirmed successful. Pending or Unclaimed keeps the reservation; confirmed failure or return releases it.

Reference: PayPal Payouts overview.

Merchant setup

1. Enable Stripe Connect and complete the platform profile.
2. Select a Sandbox/Test environment in Stripe. Open Developers → API keys and obtain its Secret key.
3. In Refmora select Sandbox / Test, enter sk_test_…, enable automatic payouts and save.
4. For Live, choose Live and enter sk_live_… through the same field. Use HTTPS and an eligible, funded platform account.

Affiliate connection

1. In Affiliate Area → Get paid with Stripe, select the actual account country.
2. Click Connect with Stripe and complete the Stripe-hosted form.
3. Return to the Affiliate Area. Use Review / resume Stripe setup if incomplete or awaiting verification.
4. Request withdrawal when transfers and payouts are enabled.

The plugin creates a Standard connected account and stores its ID. Country listing does not guarantee eligibility: Stripe and the platform's country/cross-border rules determine what is allowed. Standard account onboarding lets Stripe assign country-specific capabilities.

Transfers credit the connected Stripe balance; bank payout timing follows that account's Stripe settings. WooCommerce checkout receipts, including COD, do not automatically fund the platform balance. The platform must hold sufficient funds in the transfer currency.

Webhooks

Saving on a public HTTPS site attempts to register two snapshot destinations: platform transfer.reversed and connected-account account.updated. This integration uses v1 Accounts/Transfers, not SliceWP's v2 recipient-account API; no thin v2 destination is required.

https://example.com/wp-json/Refmora/v1/stripe

If automatic setup fails, open Advanced webhook setup. Point each destination to the displayed URL and enter its whsec_… signing secret for the selected environment. Blank preserves saved secrets; they are never displayed back in the form.

Callbacks verify signature, timestamp and environment. Reversals are confirmed through an authenticated transfer lookup. Partial returns restore earnings proportionally; duplicates do not restore funds twice. Later reservations remain protected.

Safe diagnostics

Last Stripe setup error in administrator settings shows a safe reason, stage, country, error code and request reference when available. Raw responses, keys and personal data are not displayed. A failed attempt keeps the selected country; an uncertain account creation keeps its original identity/payload to avoid duplicates.

References: Standard accounts, hosted onboarding, API keys. The flow was informed by SliceWP's guide; implementations differ.

Configure administrator recipient, sender email and sender name. Enable/disable each plain-text template and edit its subject/body.

• Admin: new affiliate; affiliate: join confirmation.
• Affiliate: application approved or rejected.
• Admin and affiliate: withdrawal requested and withdrawal status changed.
• Affiliate: commission available.

Placeholders

{site_name}        {affiliate_name}    {status}
{amount}           {method}            {note}
{payout_id}        {order_id}          {dashboard_url}
{admin_url}

Only event-relevant values are populated. Emails use WordPress wp_mail(). Check template switches, addresses and site mail transport if delivery fails; an event does not guarantee inbox delivery.

Set accent/buttons, text, secondary text, border, card background and highlighted metric color. Corner radius: 0–24 pixels. Default accent: #0066ff, matching Refmora branding.

Appearance applies to the admin panel, Affiliate Area and enabled sharing sections. Customer-facing theme styles can also affect layout.

Custom CSS

Use .refm scoped selectors. Editing requires unfiltered_html; the field is disabled otherwise.

/* Example: plugin card spacing. */
.refm .refm-card { padding: 24px; }

Preview desktop and mobile after saving.

Optional Pro activation

1. Install refmora-pro separately alongside the Free core and WooCommerce.
2. Open WooCommerce → Refmora → License.
3. Enter your license key and click Verify & activate license. Existing activation recovery does not consume another activation for the same domain.

Without an active Pro license the affiliate program continues in Free mode. General settings remain editable. Premium configuration is retained; all manual payout methods remain available. New automatic payments are unavailable. Already submitted payments retain their financial identities; keep Pro installed to reconcile their status and reversals.

Updates

Free never contacts the WP Methods license or update servers. Its updates are supplied by WordPress.org after approval and publication. Pro checks its separately hosted update service; updating Pro must not replace the Free core. The Pro server retains its existing refmint-pro product identifier; publish packages with a refmora-pro/ root folder.

Pro license API: https://wpmethods.com/LicenseValidationAffiliateWPM/api.php
Pro update metadata: https://wpmethods.com/updates-refmint/. The remote package requires a Pro-specific server release.

Settings backup

Download settings backup saves four groups as JSON: program, sharing, emails and appearance, including join settings and terms.

Restore

Upload a supported Refmora JSON backup, maximum 1 MB, and click Restore settings. Validation precedes replacement of the four groups. No license is required for backup, restore or reset. CSS restoration respects the user's capability; endpoint changes refresh routing.

Reset

Back up first. Type RESET exactly and click Reset settings. Program, sharing, email and appearance defaults are restored. License, affiliates, product rules and financial history remain. Gateway configuration is separate and is not reset.

CSV · Premium Feature

Install and activate the licensed Pro add-on. Choose Affiliates, Commissions, Withdrawals, Referred customers or Daily referral clicks. Optionally select start/end dates, then Export CSV. Empty dates include the entire dataset. Ranges use the site's timezone and include the selected end date.

Exports include all statuses and original transaction currencies. Referred customer contacts stay masked; financial exports can contain destination details and should be handled as store records. Spreadsheet formula-like cells are protected on export.

The plugin sends no-cache signals for referral landings, My Account, Cart, Checkout and logged-in personalized product sharing. LiteSpeed no-cache integration and LiteSpeed defer / WP Rocket delay script exclusions are included. A cache/CDN hit that bypasses WordPress still needs server configuration.

Cache checklist

1. Exclude refm_ref and your custom referral parameter from full-page caching.
2. LiteSpeed: Cache → Excludes → Do Not Cache Query Strings. Do not use Drop Query String for referrals.
3. Keep My Account, Cart and Checkout uncached. Do not share logged-in personalized responses.
4. Apply matching hosting, proxy and CDN rules.
5. Purge caches and test referral landings in a new browser session.

Guest product pages can remain cacheable. For optimization issues, exclude assets/account.js, assets/sharing.js and refmSharing configuration from unsuitable delayed execution.

WooCommerce and Click Shop

• Attribution hooks cover classic checkout and Checkout Blocks. HPOS and Cart/Checkout Blocks compatibility are declared.
• Click Shop's quick_order_submit path has an additional bridge for directly created orders.
• Incomplete placeholders, checkout drafts and converted placeholder records do not create normal earning commissions. Paid/reserved history is preserved during cleanup.
• For custom checkout, verify attribution on the real submitted order, not an incomplete capture.

Hooks are not a blanket guarantee for every third-party configuration. Repeat checkout tests after changing checkout, cache or hosting components.

• Signed, HTTP-only, SameSite Lax referral cookies; secure cookies on HTTPS.
• Per-affiliate serialized balance updates, reservations and persistent payment identities.
• AES-GCM encrypted provider credentials/signing secrets using WordPress salts, excluded from backups and never repopulated in forms.
• Fixed HTTPS provider endpoints, certificate checks and no HTTP redirects.
• Stripe onboarding tied to logged-in affiliate, environment and stored account. A browser return alone does not establish readiness.
• Raw-body webhook signatures with a five-minute tolerance; authenticated transfer lookup and cumulative reversal reconciliation.

Visibility and privacy tools

Affiliates see customer first names and masked email/phone data. Administrators can access relevant affiliate identity and financial records. Masking is not a restriction on every administrator record.

Review the plugin-provided text under WordPress Settings → Privacy. Data export includes affiliate data and Stripe connection IDs. Erasure removes user tracking, applications, connections and onboarding metadata; financial records remain for reconciliation. Local erasure does not delete the external Stripe account.

Connect a consent manager through refm_tracking_allowed where required by your policy. WordPress salts are used for encryption: after a migration/salt change, credentials may need to be re-entered and connections rechecked.

Referral and commission

1. Enable the program and approve a separate test affiliate. Activate Pro only when testing its premium features.
2. Open their product referral link in a fresh private session as a different buyer. Keep the same session throughout checkout.
3. Place a real submitted order. An incomplete capture alone should not create a commission.
4. Check the ledger for order reference, amount, currency and Pending status.
5. Set the order to Completed. Verify immediate availability, or the saved release date and scheduled action if using a waiting period.
6. Test variations, quantity, a coupon and a refund; review titles, rates and adjustments.
7. Repeat in another order currency if using FOX/CURCY and verify conversion.

Payout

1. Use Sandbox/Test credentials and valid test recipients only.
2. Reach the minimum, request withdrawal and verify reservation. A second open request must be blocked.
3. Approve, then run the Sandbox payout; confirm the provider reference and Sandbox successful status.
4. Confirm real paid earnings remain unchanged and funds are released after test success.
5. Test failure/uncertainty handling and signed Stripe reversals through a reachable endpoint.

Check pagination, search/filters, copy feedback, generator links, masked contacts and date-limited exports. Test restore on a test site. Saving credentials does not send a payout.