About the Payout Module

The Payout Module is part of the Rewards & Redemption family and handles cash payments to partners who earn cash rewards through the platform. Once enabled, the module connects to Stripe and/or PayPal to onboard partner payout profiles, track earnings, collect tax information where required, and process individual or batch payments.

This page is the administrator's overview — what the module does, how it fits with the rest of the Rewards & Redemption stack, the vendor and licensing requirements, and where each piece of the workflow lives. Detailed configuration, dashboards, claims handling, and troubleshooting each have their own pages.

Where the Payout Module Lives

Licensing and Prerequisites

• Payout license required. The Payout Setting page is hidden if the portal does not have the Payout license active. Contact Magentrix to enable the feature.
• At least one Cash Reward Program. Payouts only apply to Reward Programs of type Cash Reward; non-cash rewards are handled by the Redemption Module.
• A connected Stripe or PayPal Integration record. The Setting page expects you to select an Integration that already holds the live Stripe Connect or PayPal credentials. Without one, the module cannot be enabled.
• Account fields auto-created on enable. When the module is first enabled, the platform creates an AccountId lookup field on the Reward, PayoutProfile, and PayoutTransaction entities (if missing) and adds it to the default layouts. This lets payouts roll up by partner account.

Supported Vendors

You can enable one vendor or both. Each partner picks their preferred method during onboarding from the list of vendors you have enabled.

End-to-End Flow

1. Enable the module. An administrator navigates to Rewards > Payout Setting and clicks Enable to activate the Payout Module. After enabling the module, the administrator selects Stripe and/or PayPal, configures the Connected App Integration records, configures transaction fee handling, notification settings, internal recipient emails, email templates, and US Tax Tracking.
2. Configure access. The administrator opens the Access tab, selects which Partner Roles are allowed set up an Organization (Account) Payout Profile. 
3. Partner onboards. During partner onboarding, a partner user opens the Cash Reward Program and clicks Setup Withdrawal. If they choose Stripe, they are guided through the vendor’s Stripe Connect onboarding flow. If they choose PayPal, a pop‑up will open to complete the PayPal authorization. The platform stores the result as a Payout Profile record tied to the partner's account. 
4. Earnings accumulate. Approved cash rewards are added to the partner's balance on the Reward Program page. The platform shows the current balance, recent transactions, and payout-related fees. This information is displayed on the Withdrawal page after an administrator creates payouts for the partners.
5. Claim and payment. The administrator approves the claim from Review Claims. The platform processes the payment through the partner's selected payout vendor. Webhooks update each transaction's status from created to paid or failed.
6. Tax tracking (if enabled). The partner is asked to complete the required tax information during onboarding. The payout profile is not marked as complete if the partner has not set up their tax information. Administrators can monitor failed and pending payout transactions on the Payout Dashboard.

Use Cases

• Channel partner cash incentives. Pay sales partners a cash bonus for closing deals or for meeting quarterly targets. Partners self-serve their bank/PayPal details; finance reviews and pays claims in batches.
• Affiliate or referral programs. Pay affiliates a per-referral commission. Tax tracking handles accumulation and compliance.
• Marketing development funds with cash payout. Approve cash reimbursement for partner co-marketing activities. The Payout Dashboard provides finance with a complete audit trail.
• SPIFFs and short-term cash promotions. Run a limited-time cash reward and process payouts as claims are approved.

How the Payout Module Relates to the Rest of Rewards & Redemption

• The Rewards Module defines the programs and the rules that generate Reward records.
• The Redemption Module handles non-cash rewards (vouchers, catalog items, points-based redemption).
• The Payout Module handles the subset of Reward Programs whose type is Cash Reward.

Troubleshooting Tips

• If the Payout Setting page returns Not Found, confirm the portal has an active Payout license.
• If a partner cannot see the Setup Withdrawal button, confirm the Reward Program is type Cash Reward, the module is enabled, and the partner's Role is selected in the module's Role access list.
• If a payout transaction's status is stuck on created, verify the vendor webhook is reachable from the public internet and that the events listed under Supported Vendors are enabled on the vendor side.
• For full symptom-by-symptom resolutions, see Payout Module Troubleshooting.

Where to Go Next

• Payout Module Checklist — end-to-end setup steps.
• Configuring the Payout Module — full setting reference.
• Payout Dashboard — transaction monitoring.
• Review Claims — reviewing and processing payouts.
• Configuring your Payout Profile — the partner-facing setup (User Guide).

Payout Module Checklist >>