Skip to main content
The Payout domain is owned by the Payout module. This reference lists its data models and their fields. For the full module overview, see the Payout overview.

PayoutAccount

Table payout_account, id prefix pacc. A seller’s connection to the payment provider. This is the record funds are transferred to. Relations: onboarding (one-to-one, nullable), payouts (one-to-many).

Onboarding

Table onboarding, id prefix onb. Provider setup state for a payout account (for Stripe Connect, the onboarding link).
Onboarding is one-to-one with PayoutAccount. Re-running the onboarding workflow updates the existing record rather than creating a second one.

Payout

Table payout, id prefix pout. A single transfer of a seller’s earnings for one order.

Enums

PayoutAccountStatus: pending, active, restricted, rejected. PayoutStatus: pending, processing, paid, failed, canceled.