Skip to main content

Affiliate Program Owner Modules

These routes are mounted under /api/affiliate/* and are workspace-authenticated.

Feature and access model

  • Entire /affiliate/* surface requires affiliate-program entitlement.
  • Authenticated workspace context is required.
  • Module permissions are split across affiliates:*, payouts:*, and fraud:*.

Module map (route families)

  • /affiliate/programs (+ rewards)
  • /affiliate/partners
  • /affiliate/enrollments
  • /affiliate/commissions
  • /affiliate/payouts
  • /affiliate/fraud
  • /affiliate/analytics
  • /affiliate/customers
  • /affiliate/messages
  • /affiliate/groups
  • /affiliate/discounts
  • /affiliate/bounties
  • /affiliate/referrals
  • /affiliate/automation
  • /affiliate/activity-logs
  • /affiliate/invites
  • /affiliate/categories
  • /affiliate/invoices
  • /affiliate/comments
  • /affiliate/campaigns

Representative endpoints

  • GET /api/affiliate/programs
  • POST /api/affiliate/programs
  • GET /api/affiliate/partners
  • PATCH /api/affiliate/enrollments/:id/status
  • GET /api/affiliate/commissions
  • POST /api/affiliate/payouts
  • GET /api/affiliate/fraud/summary
  • GET /api/affiliate/analytics/timeseries

Money and lifecycle operations

  • Commission lifecycle: create/approve/cancel/refund/clawback/duplicate/bulk operations.
  • Payout lifecycle: create/process/retry/cancel/complete and provider-specific processing paths.
  • Fraud lifecycle: rules, groups, resolution, event inspection, and partner checks.

Typical failures

  • 403 entitlement/permission denied
  • 404 unknown partner/program/enrollment/commission/payout in workspace scope
  • 409 duplicate/constraint violations in partner and discount flows
  • provider/payment errors during payout processing