> For the complete documentation index, see [llms.txt](https://docs.cuxial.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cuxial.com/scripts/core/cuxial-banking/features.md). # Features guide How Cuxial Banking is used in game: accounts, ATMs, cards, cheques, loans, savings and the staff panel. What players and staff can do with the bank, and the rules behind each part. ## Branches and ATMs Players open the bank through the target option of a branch. Every operation is checked on the server against the player's position: away from a branch, nothing goes through. * **Branches** are points stored in the database. The first start creates them from `data/banks.lua`; after that, staff add, move and remove them from the panel. * **ATMs** work on the prop models listed in `data/atms.lua` and on any ATM point placed from the panel. * A point can be limited to one or more jobs. {% hint style="info" %} With `cuxial_interactions` running, a branch that has a ped model, or that uses the player's own look, is shown as an attended NPC. Without it, the same branch is a target zone. {% endhint %} ## Accounts | Account | Who uses it | Notes | | -------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------ | | Personal | The character | Its balance is the bank money of your framework. | | Business | The bosses of a job | One per job, created automatically from the job list of your framework. | | Shared | The owner and the members they add | Created by players for a fee. Each member gets their own permissions: deposit, withdraw, transfer and loans. | The IBAN of an account is its identifier: the character identifier, the job name or the code of the shared account. It cannot be changed. Each account has a PIN, a transaction history and, when enabled, its own loans and savings. Players can save transfer contacts, mark favourites and send one transfer to several contacts at once. ## Cards and ATMs A card is ordered at a branch, with a tier and a PIN chosen by the player. It arrives as an inventory item. * An ATM only opens when the player carries an active card, and asks for its PIN. * Whoever holds the card and knows the PIN can use it. Use by someone other than the owner is logged. * Each tier has a daily limit. Too many wrong PINs lock the card for a while. * The owner can block a card, change its PIN or replace it from the bank. Staff can block it from the panel. ## Cheques {% tabs %} {% tab title="Personal cheque" %} 1. At a branch, the player writes a cheque: payee, amount and an optional note. 2. The amount leaves their account at once and the cheque arrives as an item. 3. They hand the item to someone. 4. The holder takes it to a branch, deposits it and cashes it into their account. {% endtab %} {% tab title="Business cheque" %} 1. A boss uses the chequebook item. 2. For a few seconds (`BookSeconds`, 30 by default) a target option appears on nearby players. 3. The boss picks a player and enters the amount and an optional note. 4. The amount leaves the business account and the cheque goes straight to that player's inventory. 5. The player deposits and cashes it at a branch. Using the chequebook again puts it away. {% endtab %} {% endtabs %} {% hint style="warning" %} A cheque is paid when it is written, not when it is cashed. Whoever holds the paper can deposit it, so a lost cheque is lost money. {% endhint %} Using a cheque item from the inventory shows it on screen. ## Loans and credit score Players apply for a loan from a list of plans, each with a maximum amount, an interest rate and a number of instalments. How much they can borrow depends on the balance of the account, their existing debt and, on personal accounts, their recent paychecks and credit score. * One instalment is due every game month. A game month lasts one real day by default. * A missed instalment becomes late after the grace period and adds a penalty. After the default period the loan is in default. * While a loan is late or in default, part of every paycheck is withheld and the bank collects from the account balance. * The credit score rises with payments on time and falls with late payments and defaults. It moves the interest rate of new loans up or down. ## Savings Players create savings goals with a name and a target, move money into them and withdraw it when they want. Goals earn interest at the rate of their account type. Interest is paid once per savings week, which lasts 8 real hours by default. ## Paychecks The bank does not generate salaries. Other resources leave paychecks with the [`AddPaycheck`](/scripts/core/cuxial-banking/developers.md#addpaycheck) export, and players collect them at a branch. Collected paychecks count as income when the bank works out how much a player can borrow. ## Rewards Players earn points for deposits, withdrawals, transfers, ATM use and loan payments. Points are spent in a catalogue: cash, a waived fee, a savings interest boost or a discount on the next loan. Cooldowns, a daily cap and a check for money moved back and forth stop point farming. ## Receipts From the history, a player can print the receipt of a transaction for a fee. It arrives as an inventory item, and using it shows the receipt on screen. ## Staff panel `/bankadmin` opens the panel for staff. | Tab | What it is for | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | Overview | Money totals of the server, flow of the last 24 hours and 7 days, loans, cards and the largest balances. | | Citizens | Search a character by name or identifier. See their wealth, accounts, loans, cards and movements. Adjust a balance, set the credit score, block a card. | | Societies | Business accounts and their balances. | | Loans | Every loan. Forgive one or force its payment. | | Points | Create, edit and delete branches and ATM points: position placed in the world, ped model, blip, target zone, allowed jobs. | | Config | Edit the settings live, section by section. Reset a section to its file values, export and import. | | Audit | Every staff action: who, what and when. | {% hint style="info" %} Changes saved in Config apply at once to every player. The cheques section is the exception: it is marked in the panel as needing a restart of the resource. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.cuxial.com/scripts/core/cuxial-banking/features.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.