# Bank

> **Info:**
Every option on this page is set per currency, in **Editor > Currencies > \<currency> > Bank**, and saved to the currency's own file in the currencies folder. The bank menus are in menus/bank.yml and menus/bank-history.yml, see [Customize Menus](../configurations/customize-menus.md).

## How the Bank Works

A bank is a second balance next to the wallet, kept per player and per currency. Players put money in, it earns interest while they play, and they take it out again. Money in the bank is not in the wallet, so it can't be paid, exchanged or spent until it is withdrawn.

Players open it with `/<currency> bank`, or with Press F on the currency in the [wallet](../features/wallet.md). `/<currency> bank deposit [amount]`, `/<currency> bank withdraw <amount>` and `/<currency> bank upgrade` do the same from chat. Amounts also take `all`, `half` and percentages such as `25%`.

An [item currency](../features/item-currencies.md) stores real items in the bank and pays real items out. Every deposit and withdrawal is saved safely, so a crash can lose nothing and duplicate nothing, and the bank has a history of its own, opened from the bank menu, that holds only what went in and out of it.

## Enabled

Turns the bank on or off for this currency. It is off by default. Turning it off hides the bank and keeps what players have in it.

<figure><img src="../.gitbook/assets/bank/enabled.png" alt="" width="563"><figcaption><p>Bank</p></figcaption></figure>

## Levels

A bank has up to 21 levels, three by default. Every player starts on level 1 and upgrades with `/<currency> bank upgrade` or the upgrade button. Each level sets:

<figure><img src="../.gitbook/assets/bank/levels.png" alt="" width="563"><figcaption><p>Bank (Levels)</p></figcaption></figure>

| Option | Does |
| ------ | ---- |
| Capacity | The most the bank can hold. -1 is unlimited. |
| Interest | The percent of the bank balance paid as interest each interval. |
| Max Interest | The most one interest payment can be, whatever the balance. -1 is unlimited. |
| Upgrade Cost | What reaching this level costs. It is paid from the bank balance, not the wallet, so level 1 is free. |

Admins can move a player to any level with `/pcur bank <player> <currency> level <level>`.

## Interest Interval

How many minutes pass between interest payments. Interest is paid into the bank, not the wallet, and only to players who are online: a player's clock stops while they are offline and carries on when they return, so staying offline never earns interest. A bank with nothing in it earns nothing.

<figure><img src="../.gitbook/assets/bank/interest-interval.png" alt="" width="563"><figcaption><p>Bank (Interest Every)</p></figcaption></figure>

## Minimum Deposit

The smallest amount one deposit can be.

<figure><img src="../.gitbook/assets/bank/minimum-deposit.png" alt="" width="563"><figcaption><p>Bank (Smallest Deposit)</p></figcaption></figure>

## Withdraw Tax

The percent taken from every withdrawal. The player receives the rest, and the tax is not paid to anyone. 0 turns it off.

<figure><img src="../.gitbook/assets/bank/withdraw-tax.png" alt="" width="563"><figcaption><p>Bank (Withdraw Tax)</p></figcaption></figure>

## Daily Withdraw Limit

The most a player can take out of the bank in one day. -1 is unlimited.

<figure><img src="../.gitbook/assets/bank/daily-withdraw-limit.png" alt="" width="563"><figcaption><p>Bank (Daily Withdraw Limit)</p></figcaption></figure>

## Leaderboard Includes Bank

Counts the bank balance towards the player's place on the [leaderboard](leaderboards.md). Off by default.

<figure><img src="../.gitbook/assets/bank/leaderboard-includes-bank.png" alt="" width="563"><figcaption><p>Bank (Bank on Leaderboard)</p></figcaption></figure>

## Admin Commands

`/pcur bank <player> <currency>` shows a player's bank, online or offline. `give`, `take` and `set` change its balance, `level` sets its level and `history` opens their bank history. All of them need `phoenixcurrencies.command.bank`. `give`, `take` and `set` tell the player what changed, unless `-s` is added at the end. See [Commands](../plugin-information/commands.md).

## Placeholders

The bank has its own [placeholders](../plugin-information/placeholders.md#bank).

Source: https://www.phoenixplugins.com/docs/phoenix-currencies/main-features/bank