Marketplace Payout Object


A marketplace payout is a revenue-share payout a partner earns from a marketplace transaction, such as a template sale. Wix generates marketplace payouts automatically from marketplace transactions, so partners can't create them.

Properties
amountnumberformat double

Revenue share the partner earned on this transaction, in USD. Calculated as transactionAmount multiplied by paymentSharePercent, divided by 100.


createdDatestringRead-onlyformat date-time

Date and time the payout record was created in Wix's systems. This is record bookkeeping, not the date of the marketplace transaction. For that, use transactionDate.


idstringRead-onlyformat GUID

MarketplacePayout ID.


invoiceIdstringmaxLength 50

ID of the invoice this payout was included in, once invoiced. 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.


listingListing

The marketplace listing the transaction was made on, for example the template that was sold. The Wix Studio dashboard displays the listing's name instead of its ID and type.


negativeboolean

Whether this payout is a reversal or cancellation of an earlier payout. When true, the payout offsets a previous earning, so its amount reduces the partner's total. One positive and one negative payout are allowed per transaction. Reversals are returned by queries like any other payout, and count toward totals, so don't filter them out when summing.


paymentSharePercentnumberformat double

Fractional percent of transactionAmount the partner earns as revenue share, used to calculate amount. For example, a value of 0.05 means 0.05%.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the MarketplacePayout is updated. To prevent conflicting changes, the current revision must be passed when updating the MarketplacePayout.


statusstring

transactionAmountnumberformat double

Total price of the marketplace transaction, converted to and stored in USD.


transactionDatestringformat date-time

Date and time the marketplace transaction took place, which is when the payout was earned.


updatedDatestringRead-onlyformat date-time

Date and time the payout record was last updated. Not the date of the marketplace transaction. For that, use transactionDate.

Did this help?