A GpvPayout is a revenue-share payout derived from gross payment volume (GPV): the total payment volume processed across the sites a partner manages. Wix generates GpvPayouts automatically, creating one payout per transaction date and updating it in place as volume accrues. Partners read GpvPayouts to see what they earned and whether each payout was invoiced. All monetary values are in USD.
Amount earned by the partner for this payout, in USD. Calculated as gpv multiplied by paymentRevenueSharePercent, divided by 100.
Date and time the payout record was created in Wix's systems. This is record bookkeeping, not the day the volume was processed. For that, use transactionDate.
Total gross payment volume (GPV) processed across the partner's sites for the transaction date, in USD. Labeled Client sales in the Wix Studio dashboard.
GpvPayout ID.
ID of the invoice this payout was included in. Empty until the payout is invoiced.
This is the reference code of the partner's invoice. To resolve it, query the Materialized Invoices API for the materialized invoice whose invoicesRefCodes contains this value, and read that invoice's status to see whether it was paid.
Revenue-share rate applied to gpv to calculate amount. The value is a fractional percent: 0.05 means 0.05% (not 5%), so amount = gpv * paymentRevenueSharePercent / 100. Wix sets the rate automatically based on daily GPV: 0.05 (0.05%) when daily GPV is at or below 2000 USD, and 0.1 (0.1%) when daily GPV is above 2000 USD.
Revision number, which increments by 1 each time the GpvPayout is updated. To prevent conflicting changes, the current revision must be passed when updating the GpvPayout.
The sites whose GPV contributed to this payout, up to 200 sites, each with the volume it contributed. The Wix Studio dashboard shows only the number of sites and the first few site names, so this breakdown is more detailed than the dashboard's.
Day the payout is attributed to. Wix maintains a single GpvPayout per transactionDate, updating it as volume accrues, so payouts are returned as a flat list of days. Group them client-side if you need monthly totals.
Date and time the payout record was last updated, for example when more volume accrued for the day. Not the day the volume was processed. For that, use transactionDate.