PayoutCreated

Within a fulfillment batch, each collaborator who is owed money gets an individual payout record. When one of these records is created, Siren fires PayoutCreated. A single fulfillment paying three collaborators will produce three separate PayoutCreated events, one per payout.

The event is identified as payout_created and lives in Siren\Fulfillments\Core\Events\PayoutCreated.

What does this event carry?

The event provides the Payout model, which contains the disbursement amount, currency, and the collaborator who will receive the payment.

use Siren\Fulfillments\Core\Events\PayoutCreated;

public function handle(Event $event): void
{
    $payout = $event->getPayout();
    $amount = $payout->getValue();
    $currency = $payout->getCurrency();
    $collaboratorId = $payout->getCollaboratorId();
}

When would you use it?

Listeners subscribe to this event to react when a specific collaborator’s payout is queued. Common use cases include notifying the collaborator that a payment is being prepared, validating payment details before disbursement, or syncing payout records to external payment platforms.

Once the payout is actually disbursed, the system fires PayoutPaid as the terminal event in the payment flow.

See the Payment Events overview for how this event fits into the full payment pipeline.