Back to Script

WD-Bank | Advanced FiveM Banking System Documentation

About wd-bank

wd-bank is a premium, all-in-one Advanced FiveM Banking System designed to elevate your server's economy and roleplay experience. Featuring auto-framework detection, personal and business accounts, joint banking, and a stunning React-based NUI, it's the ultimate financial solution for any modern FiveM server.

Key Features

  • Multi-Framework Auto-Detection: Seamlessly works out-of-the-box with esx, qb-core, qbx, and standalone servers. No manual configuration required!
  • Comprehensive Personal Banking:
    • Players automatically receive a primary account upon joining.
    • Support for unlimited secondary and joint accounts for shared finances.
    • Secure deposit, withdrawal, and transfer functionalities.
  • Advanced Business Banking:
    • Auto-creates banking accounts for every job framework.
    • Job bosses are automatically synced as account owners with granular permission controls (manager, viewer).
    • Enables business-to-personal and business-to-business transactions.
  • Interactive ATM System:
    • Full interaction with GTA V ATM props (Fleeca and all ATM models) using PIN verification.
    • Sleek, mobile-friendly phone-style UI for immersive ATM access.
  • Modern & Responsive UI: Built with React 18 and Framer Motion, featuring a dark glass-morphism aesthetic, interactive card swipers, and detailed balance analytics charts.
  • Enhanced Security & Logging: Server-side validation on all transactions, atomic operations to prevent exploits, and highly configurable Discord webhook logging for complete audit trails.

Upgrade your FiveM economy today with a banking system engineered for performance, security, and aesthetics!

Installation Guide

Follow these steps to seamlessly install and configure the Advanced FiveM Banking System (wd-bank) on your server.

1. Prerequisites

Before installing, ensure your server meets the following requirements:

  • A running FiveM server (FXServer).
  • A MySQL database (MariaDB or MySQL 5.7+).
  • oxmysql and ox_lib resources installed and running.
  • A supported framework (es_extended, qb-core, qbx_core) or running in standalone mode.

2. Add Resource

  1. Download the latest release of wd-bank.
  2. Extract the folder into your server's resources directory (e.g., resources/[standalone]/wd-bank/).

3. Import Database

To set up the necessary banking tables, you must import the provided SQL file:

  1. Open your database management tool (phpMyAdmin, HeidiSQL, DBeaver, etc.).
  2. Select your server's active database.
  3. Import the banking_tables.sql file located in the root of the wd-bank resource folder. (Note: The SQL uses CREATE IF NOT EXISTS, so it is safe to run without overwriting existing data.)

4. Server Configuration

Add the following lines to your server.cfg. The start order is extremely important! wd-bank must start after its dependencies.

# 1. Required dependencies MUST start first
ensure ox_lib
ensure oxmysql

# 2. Your core framework (choose ONE)
ensure es_extended    # For ESX
# ensure qb-core      # For QB-Core
# ensure qbx_core     # For Qbox

# 3. Start the banking system
ensure wd-bank

5. Verify Installation

  1. Restart your server or run ensure wd-bank in your server console.
  2. Check the console for successful load messages (e.g., [cs-bank] Core banking tables verified).
  3. Connect to your server, head to any default bank location (like Legion Square), and interact with the banker NPC or an ATM to verify the UI opens successfully!

Configuration Options

The Advanced FiveM Banking System is highly customizable via the shared/config.lua file. This file is escrow-ignored, meaning server owners can edit it freely without touching source code.

Core Settings

  • Config.NotificationType: The notification system used. Auto-detects based on your framework, but can be forced to 'ox', 'esx', or 'qb'.
  • Config.Target: Enable or disable third-party targeting systems. Automatically prioritizes ox_target > qb-target > qbox. If set to false, it falls back to standard key press interactions.
  • Config.Locale & Config.BankName: Set your preferred language and the primary bank name (e.g., 'Fleeca Bank') displayed in the UI and on map blips.

Banking Limitations & Fees

  • Config.Banking.defaultAccount: The default account type assigned to new players.
  • Config.Banking.maxTransferAmount: The absolute maximum amount of money allowed per transaction.
  • Config.Banking.transferFee: The percentage fee taken on transfers (Set to 0 for no fees).
  • Config.Banking.enableTransactionHistory: Toggle the saving and viewing of detailed transaction history and analytics.

ATM & Banker Ped Integration

  • Config.ATM.enabled: Toggle interactions with physical ATM props in the game world.
  • Config.ATM.models: A configurable list of GTA V ATM prop model hashes. You can add custom ATM models here.
  • Config.BankerPed.enabled: Spawns invincible, static banker NPCs at all designated bank locations to process in-person transactions.
  • Config.BankLocations: A comprehensive list of vector4 coordinates defining where bank branches and Banker Peds are located (e.g., Legion Square, Paleto Bay).

Security & Performance

  • Config.Security.rateLimit: The minimum time in milliseconds between server events per player (Default: 200ms). This is a crucial security feature to prevent spamming and exploits.

Discord Webhook Logging

Monitor your server's economy with detailed, color-coded Discord logs.

  • Config.DiscordLogging.enabled: Toggle the webhook system.
  • Config.DiscordLogging.webhook: Your dedicated Discord webhook URL.
  • Config.DiscordLogging.logEvents: Granular toggles to monitor specific actions, such as deposits, withdrawals, transfers, pinOperations, and adminActions.
Claim your coupons here!