# okokBankingV2

[**YouTube Video**](https://www.youtube.com/watch?v=-bC489zMaZI)

## Installation Guide

### Requirements

ox\_lib **v3.16.2+** (<https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip>);

#### Execute the following SQL code in your database:

{% tabs %}
{% tab title="ESX" %}

```sql
ALTER TABLE `users`
    ADD COLUMN IF NOT EXISTS `iban` VARCHAR(32) NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `okok_pincode` LONGTEXT NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `okok_credit_score` INT(11) NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `okok_bank_contacts` TEXT NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `opening_date` LONGTEXT NULL DEFAULT NULL;

ALTER TABLE `users` ADD INDEX `idx_users_iban` (`iban`);

CREATE TABLE IF NOT EXISTS `okokbanking_societies` (
    `society` VARCHAR(255) NULL DEFAULT NULL,
    `society_name` VARCHAR(255) NULL DEFAULT NULL,
    `value` INT(50) NULL DEFAULT NULL,
    `iban` VARCHAR(32) NOT NULL,
    `pincode` JSON NULL DEFAULT NULL,
    `credit_score` INT(11) NULL DEFAULT NULL,
    `opening_date` LONGTEXT NULL DEFAULT NULL
);

ALTER TABLE `okokbanking_societies`
    ADD COLUMN IF NOT EXISTS `pincode` JSON NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `credit_score` INT(11) NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `okok_bank_contacts` TEXT NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `opening_date` LONGTEXT NULL DEFAULT NULL;

CREATE TABLE IF NOT EXISTS `okokbanking_accounts` (
    `account_holder` VARCHAR(64) NULL DEFAULT NULL,
    `account_identifier` VARCHAR(64) NULL DEFAULT NULL,
    `account_name` VARCHAR(100) NULL DEFAULT NULL,
    `owner_name` VARCHAR(100) NULL DEFAULT NULL,
    `balance` INT(50) NULL DEFAULT NULL,
    `iban` VARCHAR(32) NULL DEFAULT NULL,
    `pincode` JSON NULL DEFAULT NULL,
    `account_type` VARCHAR(50) NULL DEFAULT NULL,
    `daily_avg` LONGTEXT NULL DEFAULT NULL,
    `interest_total` BIGINT UNSIGNED NOT NULL DEFAULT 0,
    `okok_credit_score` INT(11) NULL DEFAULT NULL,
    `opening_date` LONGTEXT NULL DEFAULT NULL,
    INDEX `idx_okok_acc_type` (`account_type`, `account_holder`),
    UNIQUE KEY `idx_account_identifier` (`account_identifier`)
);

CREATE TABLE IF NOT EXISTS `okokbanking_loans` (
    `id` BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    `identifier` VARCHAR(64) NOT NULL,
    `label` VARCHAR(64) NOT NULL,
    `contract_total` INT UNSIGNED NOT NULL,
    `months` SMALLINT UNSIGNED NOT NULL,
    `monthly_payment` INT UNSIGNED NOT NULL,
    `months_paid` SMALLINT UNSIGNED NOT NULL DEFAULT 0,
    `paid` INT UNSIGNED NOT NULL DEFAULT 0,
    `next_due_at` INT UNSIGNED NOT NULL,
    `grace_ends_at` INT UNSIGNED NULL DEFAULT NULL,
    `status` TINYINT UNSIGNED NOT NULL DEFAULT 0,
    INDEX `idx_okb_loans_cid_status_due` (`identifier`, `status`, `next_due_at`),
    INDEX `idx_okb_loans_status_next` (`status`, `next_due_at`),
    INDEX `idx_okb_loans_grace` (`grace_ends_at`, `status`),
    INDEX `idx_okb_loans_payment` (`status`, `next_due_at`)
);

CREATE TABLE IF NOT EXISTS `okokbanking_savinggoals` (
    `id` BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    `account_holder` VARCHAR(64) NOT NULL,
    `account_identifier` VARCHAR(64) NOT NULL,
    `goal_name` VARCHAR(100) NOT NULL,
    `target_amount` INT UNSIGNED NOT NULL,
    `balance` INT UNSIGNED NOT NULL DEFAULT 0,
    `interest_total` BIGINT UNSIGNED NOT NULL DEFAULT 0,
    `daily_avg` LONGTEXT NULL DEFAULT NULL,
    `is_completed` BOOLEAN NOT NULL DEFAULT FALSE,
    `created_at` INT UNSIGNED NOT NULL,
    `completed_at` INT UNSIGNED NULL DEFAULT NULL,
    INDEX `idx_okok_goals_account_holder` (`account_holder`, `is_completed`),
    INDEX `idx_okok_goals_account_id` (`account_identifier`, `is_completed`),
    INDEX `idx_okok_goals_completed` (`is_completed`)
);

CREATE TABLE IF NOT EXISTS `okokbanking_account_users` (
    `citizenid` VARCHAR(64) NOT NULL PRIMARY KEY,
    `accounts` JSON NOT NULL DEFAULT '{}'
);

ALTER TABLE `users`
    MODIFY COLUMN `opening_date` LONGTEXT NULL DEFAULT NULL;

ALTER TABLE `okokbanking_societies`
    MODIFY COLUMN `opening_date` LONGTEXT NULL DEFAULT NULL;

ALTER TABLE `okokbanking_accounts`
    MODIFY COLUMN `opening_date` LONGTEXT NULL DEFAULT NULL;
```

{% endtab %}

{% tab title="QBCore" %}

```sql
ALTER TABLE `players`
    ADD COLUMN IF NOT EXISTS `pincode` LONGTEXT NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `okok_credit_score` INT(11) NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `okok_bank_contacts` TEXT NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `opening_date` LONGTEXT NULL DEFAULT NULL;

CREATE TABLE IF NOT EXISTS `okokbanking_societies` (
    `society` VARCHAR(255) NULL DEFAULT NULL,
    `society_name` VARCHAR(255) NULL DEFAULT NULL,
    `value` INT(50) NULL DEFAULT NULL,
    `iban` VARCHAR(32) NOT NULL,
    `pincode` JSON NULL DEFAULT NULL,
    `credit_score` INT(11) NULL DEFAULT NULL,
    `opening_date` LONGTEXT NULL DEFAULT NULL
);

ALTER TABLE `okokbanking_societies`
    ADD COLUMN IF NOT EXISTS `pincode` JSON NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `credit_score` INT(11) NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `okok_bank_contacts` TEXT NULL DEFAULT NULL,
    ADD COLUMN IF NOT EXISTS `opening_date` LONGTEXT NULL DEFAULT NULL;

CREATE TABLE IF NOT EXISTS `okokbanking_accounts` (
    `account_holder` VARCHAR(64) NULL DEFAULT NULL,
    `account_identifier` VARCHAR(64) NULL DEFAULT NULL,
    `account_name` VARCHAR(100) NULL DEFAULT NULL,
    `owner_name` VARCHAR(100) NULL DEFAULT NULL,
    `balance` INT(50) NULL DEFAULT NULL,
    `iban` VARCHAR(32) NULL DEFAULT NULL,
    `pincode` JSON NULL DEFAULT NULL,
    `account_type` VARCHAR(50) NULL DEFAULT NULL,
    `daily_avg` LONGTEXT NULL DEFAULT NULL,
    `interest_total` BIGINT UNSIGNED NOT NULL DEFAULT 0,
    `okok_credit_score` INT(11) NULL DEFAULT NULL,
    `opening_date` LONGTEXT NULL DEFAULT NULL,
    INDEX `idx_okok_acc_type` (`account_type`, `account_holder`),
    UNIQUE KEY `idx_account_identifier` (`account_identifier`)
);

CREATE TABLE IF NOT EXISTS `okokbanking_loans` (
    `id` BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    `identifier` VARCHAR(64) NOT NULL,
    `label` VARCHAR(64) NOT NULL,
    `contract_total` INT UNSIGNED NOT NULL,
    `months` SMALLINT UNSIGNED NOT NULL,
    `monthly_payment` INT UNSIGNED NOT NULL,
    `months_paid` SMALLINT UNSIGNED NOT NULL DEFAULT 0,
    `paid` INT UNSIGNED NOT NULL DEFAULT 0,
    `next_due_at` INT UNSIGNED NOT NULL,
    `grace_ends_at` INT UNSIGNED NULL DEFAULT NULL,
    `status` TINYINT UNSIGNED NOT NULL DEFAULT 0,
    INDEX `idx_okb_loans_cid_status_due` (`identifier`, `status`, `next_due_at`),
    INDEX `idx_okb_loans_status_next` (`status`, `next_due_at`),
    INDEX `idx_okb_loans_grace` (`grace_ends_at`, `status`),
    INDEX `idx_okb_loans_payment` (`status`, `next_due_at`)
);

CREATE TABLE IF NOT EXISTS `okokbanking_savinggoals` (
    `id` BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    `account_holder` VARCHAR(64) NOT NULL,
    `account_identifier` VARCHAR(64) NOT NULL,
    `goal_name` VARCHAR(100) NOT NULL,
    `target_amount` INT UNSIGNED NOT NULL,
    `balance` INT UNSIGNED NOT NULL DEFAULT 0,
    `interest_total` BIGINT UNSIGNED NOT NULL DEFAULT 0,
    `daily_avg` LONGTEXT NULL DEFAULT NULL,
    `is_completed` BOOLEAN NOT NULL DEFAULT FALSE,
    `created_at` INT UNSIGNED NOT NULL,
    `completed_at` INT UNSIGNED NULL DEFAULT NULL,
    INDEX `idx_okok_goals_account_holder` (`account_holder`, `is_completed`),
    INDEX `idx_okok_goals_account_id` (`account_identifier`, `is_completed`),
    INDEX `idx_okok_goals_completed` (`is_completed`)
);

CREATE TABLE IF NOT EXISTS `okokbanking_account_users` (
    `citizenid` VARCHAR(64) NOT NULL PRIMARY KEY,
    `accounts` JSON NOT NULL DEFAULT '{}'
);

ALTER TABLE `players`
    MODIFY COLUMN `opening_date` LONGTEXT NULL DEFAULT NULL;

ALTER TABLE `okokbanking_societies`
    MODIFY COLUMN `opening_date` LONGTEXT NULL DEFAULT NULL;

ALTER TABLE `okokbanking_accounts`
    MODIFY COLUMN `opening_date` LONGTEXT NULL DEFAULT NULL;
```

{% endtab %}
{% endtabs %}

### QBCORE ONLY

Navigate to **qb-core/server/player.lua** and add the following code underneath **`function self.Functions.SetJobDuty(onDuty) ... end`**:

```lua
self.Functions.ChangeIban = function(iban)
    self.PlayerData.charinfo.account = iban
    self.Functions.UpdatePlayerData()
end
```

### Server artifacts

Make sure your server artifacts version is above the **5181**.

* Windows: <https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/>
* Linux: <https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.okokscripts.io/scripts/okokbankingv2.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.