Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanBank

ClanBank#

ClanBank adds shared clan economy with deposits, withdrawals, statements, member contributions, withdrawal requests, protected reserves, goals, transfers, vaults and configurable progression/limits. The pages in this section explain what players see in-game, what administrators need to configure, the normal setup flow, and the most common problems you may need to diagnose.

Compatibility#

Component version: 5.1.0
Documentation release: 2026.09.5
Minimum UltimateClans version: 9.0.0

What you can do with it#

Open the bank with /clan bank view -gui (or the configured GUI action)
Deposit clan funds with /clan bank add <amount> and verify the new balance
Withdraw with /clan bank withdraw <amount> when the member role and bank rules allow it
Use /clan bank history, /clan bank contributions and /clan bank stats to audit activity
Configure a protected reserve with /clan bank reserve <amount> so normal withdrawals cannot consume money reserved by the clan
Use request for approval-based withdrawals, goal for a clan savings target, transfer for clan-to-clan money movement, and vault for additional separated balances where enabled

How it works#

How money moves through ClanBank#

ClanBank uses the UltimateClans economy integration for real balance operations and records feature-specific state such as history, contributions, requests, reserve, vaults, goals, transfers and statistics. A normal direct withdrawal must satisfy both the member's clan-role permission and the configured limits/reserve rules. Withdrawal requests provide a separate approval path when direct access should be restricted.

Use reserve when part of the main balance must not be consumed by ordinary withdrawals, vaults when you want multiple named/separated balances, goals for savings targets, and transfers for clan-to-clan movement. History/contributions/statistics are audit views, not independent balances.

First setup#

Before enabling the feature for players, review these installed files:

commands.yml
config.yml
gui.yml
language/Lang_EN.yml
polymart.yml

Recommended in-game workflow#

Open the bank with /clan bank view -gui (or the configured GUI action).
Deposit clan funds with /clan bank add <amount> and verify the new balance.
Withdraw with /clan bank withdraw <amount> when the member role and bank rules allow it.
Use /clan bank history, /clan bank contributions and /clan bank stats to audit activity.
Configure a protected reserve with /clan bank reserve <amount> so normal withdrawals cannot consume money reserved by the clan.
Use request for approval-based withdrawals, goal for a clan savings target, transfer for clan-to-clan money movement, and vault for additional separated balances where enabled.

Useful command entry points#

/{_clan} {_bank}
/{_clan} {_bank} {_add}
/{_clan} {_bank} {_withdraw}
/{_clan} {_bank} {_view} (-gui)
/{_clan} {_bank} history
/{_clan} {_bank} stats
/{_clan} {_bank} contributions
/{_clan} {_bank} request
/{_clan} {_bank} vault
/{_clan} {_bank} reserve
/{_clan} {_bank} goal
/{_clan} {_bank} transfer

See Commands in the sidebar for the full command reference and configured aliases/permissions.

GUI areas#

The installed GUI configuration contains screens/sections such as:

Bank.home_bank
Bank.bank_withdraw
Bank.bank_add
Bank.bank_history
Bank.bank_requests
Bank.bank_vaults
Bank.bank_vault
Bank.bank_contributions
Bank.bank_statistics
Bank.bank_goal
Bank.bank_amount

What administrators should configure#

Confirm an economy implementation is available to UltimateClans before allowing deposits or withdrawals.
Review role-based Bank permissions and limits in config.yml; test with a normal member and a leader.
Configure transaction/history retention, requests, goals, reserve, transfer rules, interest and upgrade/tier features only if you intend to expose them.
Keep storage consistent across servers when the network shares clan data.

Configuration map#

config.yml — Config (Bank, Icon, Permissions, logger)

The Configuration page lists the available paths and defaults from the installed configuration, with notes on what each area controls.

Before going live#

Back up the component data/configuration.
Start the server and confirm the component is detected without startup errors.
Test with a non-OP player and the lowest clan role that should have access.
Exercise the complete flow once, including the failure/deny path, not only the happy path.
Restart the server and verify that persistent state survives.
If the network is multiserver, repeat the test from a second node and verify storage/synchronization.

Troubleshooting quick reference#

Symptom	Likely cause	What to check
Deposits or withdrawals fail	Economy provider unavailable, member lacks the bank permission, amount violates a configured minimum/maximum, or reserve/limit rules block the operation	Confirm Vault/economy integration, compare the role permissions, then retry a small amount while watching console output.
Balance changes but GUI looks stale	GUI was opened before the latest transaction or a network node has not refreshed shared state	Close/reopen the bank GUI; on multiserver setups verify all nodes share the intended storage/sync configuration.
Withdrawal request cannot be approved	Request already changed state, approver lacks authority, or the bank no longer has usable funds after reserve rules	Check the request list/status, approver role, current balance and protected reserve.
Transfers do not complete	Target clan lookup, transfer limits, economy/storage state or permissions are invalid	Verify exact clan target, transfer feature settings and both clans in storage; inspect the first bank-specific console error.

For a longer diagnostic flow, open the Troubleshooting page for this component.