The Wallet Object
A wallet is automatically created the first time an approved character’s wallet endpoint is accessed. It belongs exclusively to one character and cannot be transferred or shared.A wallet is only available for characters with
idStatus: "approved". Attempting to access wallet endpoints for a draft or pending_approval character returns 403 Unauthorized.Wallet Lifecycle
1
Character is approved
Staff approve the character submission. The character’s
idStatus becomes "approved" and it becomes eligible for a wallet.2
Wallet is created on first access
The wallet is provisioned lazily — it is created the first time you call
GET /v1/users/{userId}/characters/{characterId}/wallet for an approved character that does not yet have one. You do not need to explicitly create it.3
Balance updates through transactions
Administrators can update balances directly via
PATCH (set a specific balance value) or PUT (apply a transaction amount). Regular users read their own balance using GET.Reading a Wallet
Any authenticated user can read their own character’s wallet. Staff members can read wallets for any character.Updating a Wallet
Wallet write operations require theADMINISTRATOR permission. Two update modes are available depending on what you need to do:
PATCH — Set Balance
Sets the wallet balance to an exact value. Use this when you want to assign a precise balance, such as resetting a character’s funds or correcting an error.Body:
PUT — Apply Transaction
Applies a transaction by adding or subtracting an Body:
amount from the current balance. Use positive values to credit funds and negative values to debit. The server records a transaction history entry.Bank Accounts
In addition to their wallet balance, approved characters can hold accounts at in-game banks. Bank accounts provide another layer to the economy, allowing characters to deposit and save funds separately from their on-hand balance. To retrieve all bank accounts linked to a character:Like wallets, bank account endpoints are only accessible for
approved characters. A 403 error is returned for characters in any other status.