Glossary

Plain-English definitions for everything the docs throw at you.

Ancestry chain

The list of users sitting above an invitee in a referral chain. Used by Multilevel Referral to walk up to N levels.

API key

A consumer_key + consumer_secret pair minted by an admin under Wallet → Settings → API Keys. Used for Basic Auth on the REST API.

Auto-credit

The plugin's built-in behaviour of crediting wallet automatically on certain events — recharge order completion, refund approval, cashback rule match, daily login.

Auto-deduct (BNPL)

When a customer with outstanding BNPL debt receives any wallet credit, the credit is automatically applied to repay the oldest debt first.

Background indexer

The cron-driven worker (WKWC_Wallet_Background_Indexer) that processes async tasks: bulk queue rows, daily rollups, ledger re-indexing.

Balance

The customer's wallet credit. Stored in user meta _wkwc_wallet_amount. Read via WKWP_Wallet_Core::get_balance( $user_id ).

Basic Auth

HTTP authentication header that pairs a username + password (here: consumer_key + consumer_secret) base64-encoded into Authorization: Basic <base64>.

BNPL (Buy Now Pay Later)

Customer checks out using wallet even when balance is insufficient. Shortfall recorded as debt, repayable over a configurable window. See Buy Now Pay Later.

Bonus (deposit)

A percentage credit added on top of every wallet top-up. "Pay ₹1000, get ₹1050 in your wallet." See Deposit / Top-up Bonus.

Bulk queue

Async processing table (wkwc_wallet_bulk_queue) for mass credit / debit operations. See Bulk Credit / Debit.

Caching layer

Webkul's shared multi-version cache loader. Internal — auto-invalidates on wallet writes.

Cashback

A wallet credit earned on order completion, driven by admin-defined rules. See Cashback Engine.

Connected Account (Stripe)

A acct_xxx ID belonging to the customer in Stripe Connect. The destination of a Stripe payout. See Stripe Payout.

Consumer key / secret

The two halves of an API key. Key is public-ish, secret is hashed at rest and shown once on mint.

The 7-day wkwp_ref cookie that identifies the referrer of a new visitor for the Referral Program.

Credit

A positive movement on the ledger — wallet balance goes up. Opposite of debit.

Small wallet credit on the first login per calendar day. See Daily Login Reward.

Daily rollup

Pre-computed analytics aggregations stored in wkwc_wallet_daily_rollups. Speeds up windows > 30 days.

Debit

A negative movement on the ledger — wallet balance goes down. Opposite of credit.

The PHP layer that reparents the legacy submodule template into the modern fintech My Wallet layout — without editing the underlying template. Bypassable via layout-classic mode. See My Wallet Page.

Eligibility (BNPL)

Whether a customer is allowed to use BNPL. Three modes — whitelist, role-based, all KYC-approved.

E.164

International phone format +<country><number> used by Twilio for SMS. The plugin assumes E.164 unless _wkwp_country_code_default is set to prepend.

Fee

A surcharge on a wallet operation — transfer fee, withdrawal fee. Configurable as fixed or percent.

Gateway (wallet)

The WooCommerce payment method wkwc_wallet. Lets customer pay full or part of an order from wallet balance. See Wallet Payment Gateway.

HMAC

Hash-based message authentication code. Used to sign QR pay payloads so a fake wallet ID can't be forged.

Hold period (withdrawal)

Optional delay between admin-approval and actual payout API call. Defends against fraud claw-back.

HPOS (High-Performance Order Storage)

WooCommerce 8.0+ feature that stores orders in dedicated tables instead of wp_posts / wp_postmeta. Wallet plugin is fully HPOS-compatible.

Idempotency

Property of an operation that can run many times with the same result. Wallet uses idempotency guards (e.g. _wkwp_cashback_processed) to prevent double-credits.

Invitee

The new user signing up via a referral link. The "invited" side of the referral relationship.

Invitation

A row in wkwp_referral_invitations — generated by the Invite Friends shortcode.

KYC (Know Your Customer)

Identity verification flow with document upload + admin review. Per-feature gating. See KYC.

Ledger

The append-only wkwc_wallet_transactions table — every credit / debit / refund / cashback / transfer / withdrawal as a row.

Low-balance alert

Email fired when balance crosses the configured threshold downward.

Mass Payments (PayPal)

PayPal's Payouts API. Used for wallet withdrawal payouts to customer PayPal emails. See PayPal Payout.

Multilevel referral

Chain commissions paid up the referrer ancestry. 1-10 levels. See Multilevel Referral.

Multi-currency

Per-currency balance keyed under _wkwc_wallet_amount_<currency>. Active when WOOCS or YITH currency switcher is detected.

Nonce

A short-lived random token. Used in two places:

WP REST X-WP-Nonce for AJAX calls.
QR payload nonce — rotates per QR-refresh, expires in 24h.

OTP (One-Time Password)

6-digit code sent via SMS + Email for transfer + QR pay (above threshold). 10-min expiry, bcrypt-stored. See Wallet Transfer.

Payout

Wallet money leaving the platform — bank transfer, PayPal, Stripe. Triggered on withdrawal admin-approval.

Per-form configuration

Inherited term from earlier docs — not used in wallet plugin context. Replaced by per-feature settings tabs.

Per-user phone

User meta _wkwp_user_phone (or fallback _billing_phone) holding the customer's E.164 number for SMS.

Time-boxed multiplier on referral rewards. Pure dates + multiplier (1.0 is no-op, 2.0 doubles all referral payouts in the window).

QR payload

Encoded string wkwp:<wallet_id>:<nonce>:<sig> that a wallet QR represents. Verified server-side via HMAC sig.

Recharge

The flow of customer adding money to their wallet by buying the special wkwc_wallet product. See Recharge / Top-up.

Recharge product

The auto-created WC product of type wkwc_wallet. The vehicle for top-up. Title: Recharge Your Wallet.

Reference (ledger)

Free-text tag attached to each ledger row. Audit identifier — e.g. bulk:Q4_BONUS_2026:row:1234, cashback:rule#12.

Refund-to-wallet

Two flavours:

WC admin issues a refund on a wallet-paid order → wallet credited automatically.
Customer submits a request from My Account → admin approves → wallet credited. See Refund to Wallet.