Payments, escrow and claims
Where money and items are held while a job runs, how payouts reach players, and server tax.
HireHall never trusts a promise to pay. The pay is taken when the job is posted and held until the job ends, and every payout goes through claim storage so nothing is lost when a player is offline or their inventory is full.
Escrow
- When posting, the money is taken from the employer's balance first. The job and the held pay are then saved together. If saving fails, the money and items are given back.
- When the job completes, the pay becomes a Payment claim for the worker.
- On a community job, each delivery takes its share (the amount delivered times the unit price) out of escrow as a Payment claim for that player. What is left is refunded when the job completes, is cancelled or expires.
- When the job is cancelled or expires, the pay becomes a Refund claim for the employer.
The claim is written in the same save that removes the escrow, so a crash can never lose the pay or pay it twice.
Claims
| Reason | Who gets it | When |
|---|---|---|
| Payment | Worker | A job is completed, or a player delivers to a community job |
| Refund | Employer | A job is cancelled, expires, or a declined offer is cancelled |
| Delivery | Employer | A worker delivers items on a delivery job or a community job |
| Returned items | Anyone | Items given back did not fit in the inventory |
Money
Money in a claim is paid into the player's balance straight away when they are online and the currency is loaded. Otherwise it waits and is paid when they next join. Players are told on join how many payouts are waiting.
If a deposit fails, the money is put back into the claim and the player is told.
Items
Items always wait in /hirehall claim. Click a claim to collect it, or press Collect All. What fits goes into the inventory, the rest stays in the claim for later.
HireHall never drops items on the ground. Anything that does not fit, from a cancelled posting draft to a partly collected claim, goes to claim storage.
Server tax
tax:
enabled: false
percent: 5.0With tax on, the given percentage is removed from the money of a Payment claim when it is paid out. The removed amount simply leaves the economy. Refunds, deliveries and items are never taxed. Players with hirehall.tax.bypass pay no tax.
The worker's message shows both the amount received and the tax taken.
Earned and paid totals
Each completed job with money adds to the employer's paid out total and, once the money reaches the worker, to the worker's earned total, kept per currency. They show on the profile and as the paid_<currency> and earned_<currency> placeholders.