> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roadshop.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Accounts and transfers

> Account types, shared and business accounts, transfers and history in RoadBanking

# Accounts and transfers

Players open the full bank at a **branch counter**. The eight default branches
are the Fleeca banks, Blaine County Savings in Paleto Bay and Pacific
Standard; you can move or add branches in the
[configuration](https://docs.roadshop.org/roadbanking/configuration.md#branches). A teller stands behind
each counter.

The bank closes on its own when the player walks away from the counter or
dies.

## Account types

| Type | Where the money is | Who uses it |
| - | - | - |
| **Checking** | The player's framework bank balance (own table on standalone servers) | The player. Created on the first visit. |
| **Savings** | RoadBanking | The player. Earns interest. |
| **Shared** | RoadBanking | Owner, managers and members. |
| **Business** | Your existing society money, or RoadBanking (`Config.Business.Source`) | Employees of the job, by grade. |

Every account has its own number like `LS12 3456 7890`: two letters
(`Config.Accounts.NumberPrefix`) and ten digits, the last two of them check
digits. A typo is caught before any money moves.

### Savings

Savings accounts pay `Config.Savings.InterestRate` percent every
`IntervalHours` (default 0.5 % every 24 hours). Interest is only paid on the
first `MaxInterestBalance` (default \$1,000,000).

By default, cash cannot be taken out of savings at the counter: players move
it to checking first. `Config.Savings.CashWithdraw = true` allows it.

### Shared accounts

A shared account is for a couple, a flat share or a crew. The creator is the
owner and adds players standing next to them.

| Role | View and deposit | Withdraw, transfer, cards | Members, rename, close |
| - | - | - | - |
| Owner | ✓ | ✓ | ✓ |
| Manager | ✓ | ✓ | |
| Member | ✓ | | |

Managers and members can leave the account at any time. Turning a manager
into a member, or removing someone, cancels the bank cards they held for that
account.

### Business accounts

Every job listed in `Config.Business.Accounts` gets one business account.
Players see it while that is their current job:

```lua config.lua theme={null}
Config.Business = {
    Enabled = true,
    Source = 'society',
    Accounts = {
        police = { label = 'LSPD', view = 2, withdraw = 4 },
    },
}
```

* `view`: lowest job grade that sees the account and may deposit.
* `withdraw`: lowest grade that may pay out, transfer and order cards.
* The job's boss grade always has full access.

With `Source = 'society'` the balance is your existing society money
(esx\_addonaccount, qb-management, qbx\_management or qb-banking), so boss
menus and other scripts see the same amount. `'internal'` keeps a separate
balance in RoadBanking.

### Opening and closing

**Open account** creates a savings or shared account with a name of your
choice. Limits: `Config.Accounts.MaxSavings` savings accounts per player and
`MaxShared` shared accounts a player may own or join. An optional
`OpenFee` is charged to the checking account.

An account can only be closed when its balance is zero. Closing it cancels
its cards and deletes its standing orders.

## Transfers

![Transfer screen with account picker, recipient and amount](https://mintcdn.com/roadshop/AKiPzd5n7NuA4-R3/images/roadbanking/transfer.webp?fit=max\&auto=format\&n=AKiPzd5n7NuA4-R3\&q=85\&s=4f3945475062bd87927618a15603f639)

1. Pick the account to pay from.
2. Enter the recipient's account number. Your own accounts are listed below
   for quick transfers between them.
3. Enter the amount and an optional reference, then review the transfer. The
   review shows the recipient's name before anything is booked.

Fees and limits come from `Config.Transfers`: a percentage fee with a minimum
and an optional cap, and a maximum per transfer (default \$1,000,000).

Money sent to a player who is offline arrives when they log in.

## Deposits and withdrawals

At the counter, players deposit cash into any account they may deposit to and
withdraw from accounts they may withdraw from. The cash they carry is shown at
the bottom of the sidebar.

> [!NOTE]
>
> Standalone servers have no cash, so deposits and withdrawals are hidden
> there. Transfers, cards and loans work.

## History

Each account shows its bookings with a search over names and references, an
**All / In / Out** filter and a chart of the last 30 days. Fees, interest,
loan payments and invoices appear as their own lines.

Other scripts can add lines for money they moved themselves with
[`AddTransaction`](https://docs.roadshop.org/roadbanking/api/exports#addtransaction).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.