Revenue Claims

A revenue claim is a payout owed to a seller, held as a voucher until it is collected from the claim screen. Collecting it deposits the amount into the seller balance.

How a payout reaches the seller

When a sale completes, the seller is owed the sale price minus tax (5% by default, and configurable). How that payout is delivered depends on sellerPaymentMethod:

• VOUCHER, the default, holds the payout as a claim for the seller to collect.
• DIRECT pays it into the seller balance as soon as the sale has been saved, with no voucher. If that payment fails, or the seller is offline in a currency that can only pay players who are online, such as X-Prison, zEssentials or TokenManager, the money waits as a voucher instead. A failed payout never undoes a sale.

The payout is rounded to the cent, or to a whole unit in a currency without decimals, and the tax is whatever is left of the price, so the numbers on every receipt add up.

If voucher auto-claim on join is enabled, waiting vouchers are deposited a couple of seconds after the seller logs in, so a voucher need not be collected by hand.

Expiry

Vouchers can be set to expire so unclaimed payouts do not sit forever. When a voucher expires, onRevenueExpire decides the outcome. AUTO_DEPOSIT pays the amount into the seller balance, and FORFEIT discards it. If the currency is no longer present, the voucher is kept rather than paid out in the wrong currency. Expiry runs only when it is switched on.

Refunds

A payout is also held as a claim in the rare case that a refund cannot be returned through the economy provider, so a buyer is never left out of pocket by a failed transaction.

The amount, the currency and the tax follow the original sale. See Currencies for how value is handled across currencies, and config.yml for every delivery and expiry setting.