> 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.md).

# Cuxial Banking

Bank for FiveM with personal, business and shared accounts, ATMs, cards, loans, savings, cheques and a staff panel.

Cuxial Banking is the bank of your server: branches, ATMs and one interface for every account a character can use. Staff manage the economy, the bank points and the settings from an in-game panel, without touching files.

## What it does

* **Three kinds of account.** Personal, business (one per job, run by its bosses) and shared accounts with members and per-member permissions.
* **Deposits, withdrawals and transfers** by IBAN, with saved contacts, favourites and transfers to several contacts at once.
* **ATMs** on the vanilla ATM props and on any point you place. An ATM needs a bank card and its PIN.
* **Cards** as inventory items, in tiers with their own daily limit. Cards can be blocked, replaced and charged from other resources.
* **Loans** with plans, instalments, late penalties, default and automatic garnishment of paychecks.
* **Credit score** that moves with payment behaviour and changes the interest rate.
* **Savings goals** that pay interest.
* **Cheques.** Personal cheques written at the bank and business cheques issued face to face with a chequebook item.
* **Paychecks** left at the bank by other resources, collected at a branch.
* **Rewards.** Points for using the bank, spent in a catalogue.
* **Printed receipts** as an inventory item.
* **Staff panel** (`/bankadmin`): economy overview, citizens and their wealth, business accounts, loans, bank points, live settings and an audit log.
* **Discord logs** through a webhook convar.

How each of these works in game is in the [Features guide](/scripts/core/cuxial-banking/features.md).

## Requirements

| Resource                             | Required | Used for                                                   |
| ------------------------------------ | -------- | ---------------------------------------------------------- |
| OneSync                              | Yes      | Server-side distance checks at branches and ATMs           |
| `ox_lib`                             | Yes      | Callbacks, commands, locales, dialogs                      |
| `oxmysql`                            | Yes      | Database                                                   |
| `cuxial_bridge`                      | Yes      | Connects to your framework, inventory and target           |
| An inventory supported by the bridge | Yes      | Cards, cheques, chequebook, receipts and, by default, cash |
| A target supported by the bridge     | Yes      | Interaction with branches, ATMs and players                |
| `cuxial_interactions`                | No       | Turns a bank point with a ped model into an attended NPC   |

{% hint style="info" %}
Cuxial Banking works with the frameworks supported by `cuxial_bridge`. Writing the bank movements of other resources to the transaction history requires QBox or QBCore.
{% endhint %}

## Pages

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Dependencies, items, convars and start order.</td><td><a href="/scripts/core/cuxial-banking/installation.md">Installation</a></td></tr><tr><td><strong>Features guide</strong></td><td>Accounts, ATMs, cheques and the staff panel in game.</td><td><a href="/scripts/core/cuxial-banking/features.md">Features guide</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in <code>shared/config.lua</code> and <code>data/</code>.</td><td><a href="/scripts/core/cuxial-banking/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>The staff command and who can do what.</td><td><a href="/scripts/core/cuxial-banking/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Move money, pay salaries and charge cards from your resources.</td><td><a href="/scripts/core/cuxial-banking/developers.md">Exports &amp; events</a></td></tr><tr><td><strong>Troubleshooting</strong></td><td>Common problems and how to fix them.</td><td><a href="/scripts/core/cuxial-banking/troubleshooting.md">Troubleshooting</a></td></tr></tbody></table>


---

# 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.md?ask=<question>&goal=<user_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.