Payments

/pay <player> <amount> [currency] is the one way players hand each other money. /economy pay and every currency's own pay (/shards pay <player> <amount>) run exactly the same code, so the rules below apply to all three.

What a payment checks

In this order, stopping at the first refusal:

Then the tax is taken, the amount is moved, and both sides are told. A transfer that fails after the tax was taken — the receiver's ceiling, typically — gives the tax back and says why, in the currency's own words.

The transfer tax

A stored currency's Transfer tax is a percentage charged to the payer on top of the amount:

The tax is cut to the currency's decimals, in the payer's favour, and goes to nobody: it leaves the economy. With a tax, the payer reads "You paid 100 to Steve. Tax: 5" instead of the plain line. The ledger records it as its own line, pay:tax.

Confirmation above an amount

pay-confirm-above in config.yml makes a large payment ask first:

pay-confirm-above:
  default: '10k'
  shards: '500'

Keys are currency ids; default covers every currency not listed. Amounts read like the command's. '0' never asks, which is what a fresh server writes.

A payment above the amount answers "Send 20,000 to Steve? [✔ CONFIRM] 30s". Clicking [✔ CONFIRM] runs /pay Steve 20000 dollars confirm; typing the same thing works too. The confirmation:

• lasts 30 seconds;
• is bound to the exact receiver, currency and amount — a confirm for anything else confirms nothing: "Nothing to confirm: it expired or changed.";
• is used up by the payment it allows, and replaced by the payer's next question;
• is only asked when the payer could afford it, so nobody confirms a payment that is then refused.

/pay Steve 20000 confirm — confirm straight after the amount — means the default currency.

Turning payments off

/paytoggle stops a player receiving payments, and running it again turns them back on. It is kept in the database, so it holds on every server of the network and through restarts, and a toggle made on one server applies to the next payment anywhere. Players with exyliaeconomy.paytoggle.bypass (operators by default) pay them regardless.

It only stops /pay and the currency pay commands. Admin commands, interest, banknotes and other plugins still pay them.

Telling the receiver

The offline notice is offline-pay-notice in config.yml, on by default. It keeps its own table, exylia_pay_notices, rather than reading the ledger, so it works with the ledger turned off. Each notice is shown once, even if the player joins two servers in a row.

Exchanging currencies

/economy exchange <amount> <from> <to> — or /shards exchange <amount> <to> — swaps one currency for another at the source's rate. It needs Exchange on the source currency, a rate from it to the target, and the target currency's permission. EconomyExchangeEvent fires first, and a listener may cancel it.

The ledger records both sides as exchange:<from>><to>. See Currencies for how the amounts are rounded.

Giving everybody

/economyadmin giveall <currency> <amount> gives an amount to every player online on this server. It always asks first — "Give 100 to each of the 24 players online? [✔ CONFIRM]" — and the click runs the same command with confirm. Each player gets a separate deposit, with its own ledger line (admin:giveall) and its own "You received 100."; a player without the currency's permission, or whose ceiling refuses it, is skipped and counted: "Gave 100 to 23 players. Skipped: 1".

Admin changes

/economyadmin give, take, set and reset work on any player the network knows. On a player who is not on this server the change is queued and lands where they are, or when they are next seen; the admin reads "Queued +100 for Steve. They are away; it lands when they are next seen." instead of a balance. See Network for what a queued change does.

A player online here is told "You received …" or "… was taken from you."; set and reset say nothing to them.