Payout Module Checklist

Use this checklist to set up the Payout Module end to end. Configuration lives at Setup > Create > Rewards > Payout Setting. Each step links to a detailed article.

Plan

☐ Decide which vendors you will support. Stripe Connect, PayPal Payouts, or both. Partners pick from the vendors you enable.

☐ Decide who can request payouts. Identify the Partner Security Roles whose users should be able to set up a Payout Profile.

☐ Decide on financial policy. Will partners cover transaction fees? Is US tax tracking required? Is there a minimum Earning Threshold before a partner can request a payout?

☐ Identify internal recipients. List the internal email addresses that should be notified when a partner adds or updates a Payout Profile.

Connect a Vendor

☐ Create or confirm an Integration record for Stripe and/or PayPal with live API credentials. Stripe uses Stripe Connect; PayPal uses the Payouts API.

☐ Verify the magentrix webhook endpoint is reachable. The platform registers vendor webhooks on save (/payoutprofile/stripewebhookhandler and /payoutprofile/paypalwebhookhandler). Both must be reachable from the public internet for transaction status updates to flow back.

Configure

☐ Configure the Payout Module Enable the module, select the available payout methods, attach the vendor Connected App(s), and save. Saving auto-creates the vendor webhooks and provisions AccountId fields on Reward, PayoutProfile, and PayoutTransaction if missing.

☐ Set the Earning Threshold (optional). Partners cannot request a payout until their balance meets this amount.

☐ Configure US Tax Tracking (optional). When enabled, partners are prompted for tax information during onboarding so you can produce US 1099-style reports.

☐ Select Partner Roles. Pick which Partner Roles are allowed to set up a Payout Profile. Partners outside these Roles cannot see the Setup Withdrawal flow.

☐ Configure notifications. Pick an email template for profile-update notifications, add internal recipient emails, and decide whether partner account owners are notified on Payout Profile changes.

Test

☐ Test as a partner user. Sign in as a partner whose Role is in the access list. Open a Cash Reward Program and confirm Setup Withdrawal is visible. Walk through onboarding for each enabled vendor.

☐ Generate a small test reward. Approve a small cash reward against the test partner so the dashboard has a transaction to display.

☐ Process a test claim. From Managing Payout Claims, approve and pay the test transaction. Confirm the vendor receives the payment and the transaction status flows from created to paid via the webhook.

☐ Confirm the Payout Dashboard reports correctly. See Payout Dashboard to verify the transaction appears with the right amounts, fees, and partner account.

Roll Out

☐ Announce the program. Communicate to partners that cash payouts are available and what they need to do to set up their Payout Profile.

☐ Publish or link the partner-facing guide. Direct partners to Configuring your Payout Profile.

☐ Schedule periodic reviews. Plan a regular cadence for reviewing payout claims, monitoring transaction failures, and reconciling with your finance system.

If You Run Into Issues

☐ Payout Module Troubleshooting Symptom-by-symptom resolutions for webhooks, license, role access, onboarding, tax forms, country support, and vendor errors.

<< About the Payout Module | Configuring the Payout Module >>