Skip to main content

Funds

This page presents the configuration and usage of the Funds addon for ClientXCMS. Objective: allow customers to credit their balance (pre-payment) and, if you allow it, transfer funds to other accounts.


1. General Principle

  1. Account Credit

    • The customer chooses an amount (within the allowed range) and pays via their chosen payment gateway.
    • The ClientXCMS Balance is immediately updated after payment validation.
  2. Fund Transfer (optional)

    • If enabled, a customer can send all or part of their balance to another account.
    • Rules (delay, minimum, maximum, prior deposit) prevent abuse.
  3. Tracking & History

    • Administration table to trace all transfers.
    • "Payment Methods" page on client side with detailed history.

2. Prerequisites

Once the extension is activated:

  • Administration → Settings → Extension Settings → Funds
  • Transfer management: Administration → Settings → Extension Settings → Funds (Transfers tab)
ElementDetail / Version
Add-onFunds (free, core)
GatewayAt least one active gateway (Stripe, PayPal, etc.)
Client Role"Add / transfer funds" authorization (enabled by default)

3. Global Settings

img

SectionFieldFunctionExample
Credit FundsMinimum / maximum amountLimits for a single deposit5 · 1000
Transfer FundsCheckbox "Allow transfers"Enables or disables the feature✅ / ❌
Minimum / maximum amount (transfer)Allowed range for a transfer5 · 1000
Transfer delay (minutes)Anti-spam between two transfers from same client5
Minimum deposit requiredBalance to credit before being able to transfer5 (0 to disable)

Amounts follow your store's main currency.

Click Save to apply.


4. Transfers Table (administration)

img

  • #: internal identifier
  • Customer / Recipient
  • Amount
  • Status: Completed / Pending / Cancelled
  • Transfer date
  • Created: request date

Use standard filters (date, customer, status) for your audits or disputes.


5. Credits and Transfers on Client Side

img

My Account → Payment Methods

5.1 Credit My Account

  1. Enter an amount (between min & max).
  2. Select the payment gateway.
  3. Validate: balance is updated after successful payment.

5.2 Transfer Funds (if enabled)

  1. Enter the amount and recipient's email.
  2. Check the summary: limits, balance, remaining delay.
  3. Click Transfer.
  4. The recipient instantly receives the credit and a notification email (if enabled).

A table summarizes Transfer History (status + possible actions, e.g., cancellation while Pending).


6. Best Practices

  1. Balanced limits: set min/max consistent with your rates to avoid costly micro-payments or overly high deposits.
  2. Anti-fraud: maintain a few minutes delay between two transfers and require a minimum deposit before any transfer.
  3. Support: keep the transfer ID for any complaint.
  4. Communication: specify in your terms that the balance is non-refundable (if that's your legal choice).
  5. Logs: regularly check the transfer list to detect any anomalies.