Payouts API
Payout batch management, transaction operations, payout processing, and CSV export.
Authentication
Payout routes are protected by PayoutPolicy. Admin users have full access; affiliate-level users require read_all_payouts.
Endpoints
| Method | Path | Edition | Operation | Controller |
|---|---|---|---|---|
GET | /payouts | Core | List Payouts | PayoutController@index |
POST | /payouts/validate-payout-config | Core | Validate Payout Config | PayoutController@validatePayoutConfig |
POST | /payouts/process-payout | Core | Process Payout | PayoutController@processPayout |
GET | /payouts/{id} | Core | Get Payout | PayoutController@show |
GET | /payouts/{id}/referrals | Core | List Payout Referrals | PayoutController@getReferrals |
GET | /payouts/{id}/transactions | Core | List Payout Transactions | PayoutController@getTransactions |
GET | /payouts/{id}/transactions-export | Core | Export Payout Transactions | PayoutController@getExportableTransactions |
DELETE | /payouts/{id}/transactions/{transaction_id} | Core | Delete Payout Transaction | PayoutController@deleteTransaction |
PATCH | /payouts/{id}/transactions/{transaction_id} | Core | Update Payout Transaction | PayoutController@patchTransaction |
PATCH | /payouts/{id}/transactions/bulk-action | Core | Bulk Update Payout Transactions | PayoutController@bulkPatchTransactions |
PATCH | /payouts/{id} | Core | Update Payout | PayoutController@updatePayout |