Configuration

Page dedicated to how to configure our Banking

Languages

You can set the language of the script in the configuration file.

en: English
fr: French
pl: Polish
de: German
es: Spanish

ATM's

Defines ATM models that can be used for interactions via target systems:

AtmModels: A list of object model names (hashes) recognized as ATMs. These are used to place interaction zones for opening the banking UI.

📌 Default supported models: • prop_fleeca_atm • prop_atm_01 • prop_atm_02 • prop_atm_03 You can add or remove models based on your server's mapping.

Target

Defines the targeting system used for ATM and bank interactions:

Target.ox_target: Set to true if you're using ox_target.
Target.qtarget: Set to true if you're using qtarget.
Target.qb_target: Set to true if you're using qb-target.
Target.own: Set to true if you're using a custom targeting system. Requires manual implementation in client/editable.lua.
Target.useE: Set to true to allow interactions using the E key instead of a target system.

Zones

Defines all coordinates, labels, and settings for bank and ATM interaction zones:

`Zones.Bank`:

Settings for in-world bank locations with optional NPCs and interaction support.

Color: Blip color ID for the map.
Label: Name shown on the blip (e.g., 'Bank').
Sprite: Blip icon ID used for banks.
Scale: Size of the blip icon.
labelTarget: Text shown when targeting the bank with a targeting system.
labelATMtarget: Text for ATM interaction via target.
labelNoTarget: Prompt shown if using interaction without a target system (e.g., "Press ~~INPUT_CONTEXT~~").
icon: Font Awesome icon used in the target interaction (e.g., 'fa fa-bank').
pedModel: Ped model spawned at the bank.
scenario: Animation scenario used by the ped.
coords: List of bank locations (vector3).
pedHeading: Heading values (one for each ped location).
distance: Max distance required to interact.
groups: Job restriction (set to nil for no restriction).
bank: Set to true to mark this as a bank zone.

`Zones.ATM`:

Settings for ATM locations used when not relying on target models.

labelNoTarget: Prompt shown for ATM interaction without target.
labelATMtarget: Text for ATM interaction via target system.
coords: List of ATM coordinates to be used without model-based detection.
pedHeading: Heading for optional NPC near the ATM.
distance: Max interaction distance.
groups: Job restriction (set to nil for no restriction).
bank: Set to false to mark this zone as ATM (not a bank).

📌 If you're using a targeting system, ATMs will automatically work based on models defined in Config.AtmModels. If not, you must manually define ATM coordinates here.

Banks

Defines standalone bank locations with optional blip configuration:

Position: Coordinates and heading (vector4) for the bank location.
Blip: Controls whether a map blip is displayed at this location: • Enabled: Set to true to show the blip on the map. • Color: Blip color ID. • Label: Name shown on the map (e.g., 'Bank'). • Sprite: Icon used for the blip (e.g., 108 for banks). • Scale: Size of the blip icon on the map.

📌 You can define multiple bank locations by adding more entries to the list.

Exports

Server-side exports for the our banking resource

GetAccountBalance

Retrieves the current bank account balance of a player.

Parameters:

playerId (number) – The server ID of the player.

Returns:

success (boolean) – Whether the operation was successful.
result (number|string) – The account balance if successful, or an error message if failed.