Banking

Exports

All client- & serversided exports included within this script. Exports provide callable functions that allow other resources to interact with this script's functionality.

If additional exports are required for your implementation, please submit a formal request through our ticketing system on the official Discord server.

Server Exports

GetAccount

Returns an account.

exports['RxBanking']:GetAccount(iban)

iban

string required

Iban of the account.

GetLoan

Returns the current active loan from a player.

exports['RxBanking']:GetLoan(identifier)

identifier

string required

Identifier of the player.

AddAccountMoney

Adds money to an account.

exports['RxBanking']:AddAccountMoney(iban, amount, type, reason, fromIban)

iban

string required

Iban of the account.

amount

number required

Amount that needs to be added.

type

'payment'|'deposit'|'withdraw'|'transfer'|'interest'

Optional type of adding money for the transaction.

reason

string

Optional reason of adding the money for the transaction.

fromIban

string

Optional iban to show where the money came from for the transaction.

RemoveAccountMoney

Removes money from an account.

exexports['RxBanking']:RemoveAccountMoney(iban, amount, type, reason, toIban)

iban

string required

Iban of the account.

amount

number required

Amount that needs to be added.

type

'payment'|'deposit'|'withdraw'|'transfer'|'interest'

Optional type of removing money for the transaction.

reason

string

Optional reason of removing the money for the transaction.

toIban

string

Optional iban to show where the money went, for the transaction.

AddSocietyMoney

Adds money to a society account.

exports['RxBanking']:AddSocietyMoney(society, amount, type, reason, fromIban)

society

string required

Name of the society.

amount

number required

Amount that needs to be added.

type

'payment'|'deposit'|'withdraw'|'transfer'|'interest'

Optional type of adding money for the transaction.

reason

string

Optional reason of adding the money for the transaction.

fromIban

string

Optional iban to show where the money came from for the transaction.

RemoveSocietyMoney

Removes money from a society account.

exports['RxBanking']:RemoveSocietyMoney(society, amount, type, reason, toIban)

society

string required

Name of the society.

amount

number required

Amount that needs to be added.

type

'payment'|'deposit'|'withdraw'|'transfer'|'interest'

Optional type of removing money for the transaction.

reason

string

Optional reason of removing the money for the transaction.

toIban

string

Optional iban to show where the money went, for the transaction.

GetPlayerBankAccounts

Returns all bank accounts of a player

exports['RxBanking']:GetPlayerBankAccounts(identifier, includeAuthorized, filter)

identifier

string required

Identifier of the player.

includeAuthorized

boolean

Should also return accounts where player is authorized to?

filter

FilterOptions

Optional filter to specify which accounts should be returned. See FilterOptions below.

Type Definitions

type

'checking'|'saving'

Account type to filter by.

count

boolean

If true, returns only the count of accounts instead of full account data.

GetPlayerPersonalAccount

Returns the personal account of a player. This account is synced with the HUD and framework bank balance.

exports['RxBanking']:GetPlayerPersonalAccount(identifier)

identifier

string required

Identifier of the player.

GetSocietyAccount

Returns the account of a society.

exports['RxBanking']:GetSocietyAccount(society)

society

string required

Name of the society.

CreateTransaction

Creates a transaction. This is just for display, it does not really transfer money.

exports['RxBanking']:CreateTransaction(amount, type, fromIban, toIban, reason)

amount

number required

Amount of the transaction.

type

'payment'|'deposit'|'withdraw'|'transfer'|'interest' required

Type of the transaction.

fromIban

string

Optional iban where the money is 'removed' (not real) from.

toIban

string

Optional iban where the money is 'added' (not real) to.

reason

string

Optional reason for the transaction.

Client Exports

No client-sided exports available at this time.

Installation

Full installation guide to get this script up & running in no time.

Events

All client- & serversided events included within this script. Events serve as listeners that capture and respond to actions executed by this script.