Documentation
Learn how the script works, explore its main features, and discover how to configure and use everything with ease.
Where | How |
|---|---|
Bank counter | Interact at the branch — full dashboard |
ATM | Interact with any ATM — limited to basic operations |
Credit card | Using the item opens the PIN pad, then an ATM session |
At a counter a player can deposit, withdraw, transfer, manage cards and PINs, , run , access their and browse the .
Player money is never touched directly — every movement goes through the framework adapter. A counter or ATM operation runs:
Limit check — the hourly ATM cap, plus the deposit, withdraw and transfer switches.
Available balance — the raw balance minus any held deposits.
Branch fee — the branch's fee %, when enabled for that operation. Fees credit the branch treasury.
Move the money, and write the transaction feed and history.
Record the customer — visits, volume and fees paid.
Notify — in-game toast, plus a phone push if enabled.
Webhook, if a URL is set for that action.
A branch's treasury is a working float. It is lent from and repaid into, and it cannot be withdrawn below the amount it was seeded with.
It also stays with the branch when it is sold — otherwise buying and reselling would mint money.
An unowned branch is a plain counter. An owner buys the rest from their own bank account:
Licence | Unlocks |
|---|---|
| Company book in Manage |
| Lending desk |
| Mortgage desk |
| Buying homes from residents, reselling, and taking collateral |
| Raises the hiring cap |
| One extra teller NPC per purchase, up to the maximum |
Titles and descriptions come from the locale files, which is also how you document licences you invent.
Seven permissions are available:
finance · withdraw · credit · customers · settings · staff · doors
Default ranks are Manager (everything), Banker (finance, credit, customers, doors) and Teller (customers, doors). Owners edit them in Manage → Staff.
The owner always has every permission, and Config.Ownable.adminOverride lets admins manage any branch.
Branch doors are picked in the creator and stored on the branch.
An unowned branch is public — its doors cannot be locked at all.
The owner always has keys; staff need the doors permission.
lockedOnBuy locks the branch the moment it is sold.
Loan terms come from three layers, in order: the global default → the branch's own terms → the customer's credit score tier, which applies an amount multiplier and an interest delta on top.
The score runs from 300 to 850 and is recomputed from history: loans repaid, payments missed, defaults, open loans and loyalty. It also gates which card tiers a player can be issued.
request → pending ──approve──► approving → active ──all instalments──► paid
│ │
└──reject──► rejected └── missed ≥ maxMissed → defaultedA state-owned branch with autoApprove grants instantly. An owned branch always waits for a banker, and pays out of its treasury — the grant is refused if the treasury is short.
Instalments are charged every 60 seconds for anything due. A failed charge adds a late fee and increments the missed counter.
On default, a loan with house collateral triggers a seizure.
Early payoff clears the remaining debt in one payment when enabled.
Cards are only issued at a counter, never at an ATM, and only at branches that allow it.
A card is a tier, not a colour — each tier has a minimum credit score and a price.
The maximum cards per player and the number of wrong PIN attempts before a card is blocked are both configurable.
Using the card item opens the PIN pad, then an ATM session.
A branch with the customers permission can freeze or cancel a customer's card from their file.
A deposit at or above the minimum is credited to the account and then frozen — the customer sees the money but cannot withdraw or transfer it.
The held amount is subtracted from the spendable balance everywhere.
Setting | Effect |
|---|---|
| Whether ATM deposits are screened too |
| How long the hold lasts. |
|
|
With
autoRelease = false, a hold survives until a banker with thefinancepermission clears it — so a branch nobody runs can sit on the money indefinitely. That is deliberate, and it is the only way a balance can look frozen forever.
A banker can clear or return the deposit from Manage → Finance, or from the customer's file.
Society accounts live in Quasar Banking's own table, so behaviour is identical on ESX and QBCore — with no esx_addonaccount and no qb-management.
autoCreate opens the account the first time a worker banks.
ESX has no boss flag, so a grade threshold decides who counts as a boss.
Roles carry view, deposit, withdraw, transfer and manage, plus a rolling limit per time window. A limit of 0 means no cap.
Every movement is logged with who, what and why.
Other resources move this money through the exports.
Player-to-player transfers that repeat on a schedule.
Each player can hold a maximum number of orders, each within an amount range and no more often than the minimum interval.
Due payments are charged every 60 seconds, taking a fee per payment.
A failed charge increments the failure counter. At the retry limit the order is paused, not deleted — the player resumes it from the interface.
Both sides are notified, and the payer gets a phone push when enabled.
The whole property section requires qs-housing to be running and Config.RealEstate.enable to be on. When either is missing, the Mortgage tab and the Property desk are never sent to the interface.
Only owned branches holding the realestate licence can use it.
resident sells up branch decides branch resells
────────────────── ────────────── ──────────────
Offer() → Resolve(accept) → SetListing(listed, price)
takeHouse() → a player buys it
→ direct sale to a player
→ Release (back to the market)Offer — a resident offers a house to any licensed branch. Refused if the house is rented, still mortgaged, already offered, or the branch has 20 pending offers.
Resolve — accepting pays the seller from the treasury and moves the deed to the branch owner.
Release — sells back to the state for a configured percentage and returns the house to the market.
The house cap is always honoured — a branch cannot sell a listing to someone who is already at their limit.
They coexist and are shown side by side in the Credit tab. Don't confuse them:
Housing mortgage (native) | Bank mortgage | |
|---|---|---|
Created by |
| The Mortgage tab at a branch |
Terms | Whatever qs-housing set | Global — the debt lives on the house, so every bank offers the same |
Instalments | Charged by qs-housing | Charged by Quasar Banking |
Paying a housing mortgage through the Credit tab never touches qs-housing's own schedule.
A house can be pledged against a loan when collateral is enabled and the branch holds the realestate licence.
The pledge is refused when:
Reason | Meaning |
|---|---|
| The house is not owned by the borrower |
| Rented properties cannot be pledged |
| It still carries a housing mortgage |
| Another loan already holds it |
| The loan exceeds the maximum loan-to-value % (70 % by default) |
When a loan with house collateral defaults, the branch seizes the house, the ex-owner is notified by phone, and the pledge is cleared so it cannot be seized twice.
Set Config.RealEstate.enable = false for the whole property section, or Config.Mortgage.enable = false for bank mortgages only.
Stopping qs-housing achieves both at runtime with no config change.
Open it with:
/bankcreatorAccess is granted to admins (when allowAdmins is on), to the jobs and grades listed in Config.Creator.jobs, and to any configured ACE.
Placement runs a free camera with a live, translucent preview of the actual ped or prop.
Control | Action |
|---|---|
| Fly |
| Raise / lower the camera |
| Rotate the prop — hold |
Mouse wheel | Raise / lower the prop (±5 m) |
Left click | Place |
| Cancel |
Rotation and height are drawn on screen while placing, and re-placing an existing prop starts from the rotation it already had.
A separate mode: aim at a door, left click to add or remove it, Backspace to undo, Enter to finish. Picked doors are outlined green.
Thread | Interval | Does |
|---|---|---|
Loans | 60 s | Charges due instalments, late fees, defaults, seizures |
Screening | 60 s | Releases expired deposit holds |
Standing orders | 60 s | Charges due scheduled payments |
ATM limits | 10 s | Drops hourly ATM counters older than an hour |
Each one is wrapped so that a bad row logs and the loop survives.
Everything under these paths is outside escrow and safe to edit:
Path | For |
|---|---|
| Every tunable setting |
| Interface and server messages — 40 languages, missing keys fall back to English |
| Discord URLs for deposits, withdrawals, transfers and card creation |
| Hook your own logging into every movement |
| Tie bank activity into missions and jobs |
| Reference for adding an inventory adapter |
| Zone definitions per targeting resource |
| Add a framework by implementing the same globals |