Accueil › Documentation › Exports · origen_banking

Exports · origen_banking

Tous les exports sont enregistrés sous le nom de ressource origen_banking et sont exclusivement côté serveur.

Enveloppe de réponse

La plupart des exports de comptes renvoient une enveloppe structurée plutôt qu’un simple booléen :

-- success
{ success = true, data = { ... }, meta = { message = { key = '...', args = { ... } } } }
 
-- failure
{ success = false, error = { key = 'errors.insufficient_balance', args = { ... } } }

Le champ key est une clé de langue issue de locales/*.json, ce qui permet à la ressource appelante de traduire elle-même le message.

Comptes de métier et de société

getJobAccountBalance(jobName) → number, string|nil

Renvoie le solde actuel d’un compte de métier. Lecture seule : ne crée jamais le compte.

local balance, err = exports['origen_banking']:getJobAccountBalance('mechanic')

Renvoie 0 et un motif d’erreur ('invalid_job_name' ou 'account_not_found') quand le compte n’existe pas.

depositJobAccount(jobName, amount, detail) → table

Ajoute de l’argent à un compte de métier. Crée automatiquement le compte s’il n’existe pas encore.

local res = exports['origen_banking']:depositJobAccount('mechanic', 2500, 'Repair job')
if res.success then print(res.data.balance) end

Erreurs : invalid_amount, invalid_job_name.

withdrawJobAccount(jobName, amount, detail) → table

Retire de l’argent d’un compte de métier. Ne crée jamais le compte automatiquement.

local res = exports['origen_banking']:withdrawJobAccount('mechanic', 500, 'Parts purchase')

Erreurs : invalid_amount, account_not_found, insufficient_balance.

getAccountMoney(accountName) → number

Alias hérité de getJobAccountBalance. Renvoie uniquement le solde, ou 0.

addAccountMoney(accountName, amount) → boolean

Dépôt hérité. Crée automatiquement le compte. Enregistre la transaction sous le nom Society income.

removeAccountMoney(accountName, amount) → boolean

Retrait hérité. Renvoie false quand le compte n’existe pas ou que le solde est insuffisant.

Comptes

newAccount(data) → Account

Crée un objet de compte. Si data.id est omis, un nouvel IBAN est généré et le compte est enregistré immédiatement.

GetAccountById(id) → Account | nil

Renvoie le compte depuis le cache en mémoire et, à défaut, le cherche en base de données.

local account = exports['origen_banking']:GetAccountById('1234567890123456')

GetAccountAccessByCitizenid(citizenid) → table

Renvoie la liste d’accès brute d’un citoyen : un array de { accountId, permission }. La permission vaut 'owner', 'manager' ou 'operator'.

GetAccountsInfoByCitizenId(citizenid) → table

Renvoie la liste complète des comptes d’un citoyen, enrichie pour l’interface : membres, type de compte ('personal' / 'shared'), l’indicateur de compte principal du framework et le solde en direct. Les comptes de métier et de gang auxquels le joueur a accès à cet instant sont ajoutés à l’exécution.

CreateInitialAccount(citizenid) → string

Crée le compte principal d’un citoyen et renvoie l’ID de compte généré.

LoadAccountsForPlayer(citizenid)

Précharge en mémoire tous les comptes appartenant à un citoyen ou partagés avec lui. Les comptes sont chargés à la demande lors de la connexion du joueur ; ce n’est donc utile que pour les opérations sur des joueurs hors ligne.

Paiements

GetActiveAccBalance(source) → number | nil

Renvoie le solde du compte actif du joueur. Mis en cache pendant 500 ms.

PayWithAccId(accountId, amount, detail) → table

Débite un compte précis à partir de son ID.

Erreurs : errors.account_not_found, errors.insufficient_balance.

PayWithActiveAcc(source, amount, detail) → table

Débite le compte actif du joueur.

local res = exports['origen_banking']:PayWithActiveAcc(source, 150, 'Parking fee')
if not res.success then print(res.error.key) end

PayFromDefaultAcc(source, amount, detail) → table

Débite le compte par défaut du joueur. Quand ce compte est le compte principal du framework, le solde est prélevé sur l’argent bancaire du framework plutôt que sur la base de données.

ReceiveToActiveAcc(source, amount, detail) → table

Crédite le compte actif du joueur.

ReceiveToDefaultAcc(source, amount, detail) → table

Crédite le compte par défaut du joueur. Les comptes principaux du framework sont crédités directement sur l’argent bancaire du framework.

SetActiveAccBalance(source, amount) → boolean

Remplace le solde du compte actif du joueur. Aucune transaction n’est enregistrée.

SetDefaultAccBalance(source, amount) → boolean

Remplace le solde du compte par défaut du joueur. Si c’est le compte principal du framework, la différence est appliquée à l’argent bancaire du framework.

Prêts

CreateLoan(accountId, typeKey, amount, term, collateral) → table

Crée un prêt sur un compte en appliquant toutes les validations côté serveur.

local res = exports['origen_banking']:CreateLoan(accountId, 'personal', 15000, 12)
if res.success then print(res.loanId) end

Erreurs : disabled, account_not_found, invalid_type, invalid_term.

GetPlayerLoans(citizenId) → table

Renvoie tous les prêts d’un citoyen, sous la forme où l’interface les reçoit.

HasOverdueLoan(citizenId) → boolean

Renvoie true quand le citoyen a un prêt en retard ou en défaut de paiement. Utile pour restreindre les achats à crédit dans les concessions, les locations et les ressources similaires.

if exports['origen_banking']:HasOverdueLoan(citizenid) then
    -- deny the financed purchase
end

Banques

newBank(data) → Bank

Crée une entité bancaire.

GetBankById(id) → Bank | nil

Renvoie une banque depuis le cache ou la base de données.

Cartes

newCard(data) → Card

Crée une carte liée à un compte.

GetCardById(id) → Card | nil

Renvoie une carte depuis le cache ou la base de données.