Skip to content

Payout Events

Events published during the payout lifecycle — from request through approval to completion.

INFO

Payout events follow a state machine pattern: requested → approved/denied → processing → completed/failed. Each transition publishes an event for audit trail and downstream processing. Bank account verification events are prerequisites for payout requests.

payout.requested

Published when a campaign owner initiates a payout.

FieldTypeDescription
payoutIdstringUUID of the payout
campaignIdstringSource campaign UUID
amountnumberRequested payout amount
bankAccountIdstringVerified bank account UUID

payout.approved

Published when an admin approves the payout request.

FieldTypeDescription
payoutIdstringUUID of the payout
approvedBystringAdmin UUID

payout.completed

Published when funds are successfully transferred.

FieldTypeDescription
payoutIdstringUUID of the payout
transferIdstringStripe transfer ID

payout.failed

Published when the transfer fails.

FieldTypeDescription
payoutIdstringUUID of the payout
reasonstringFailure reason

Built with VitePress