Adjust Cash

POST

https://demo.tradovateapi.com/v1/fundTransaction/adjustcash

POST

/v1/fundTransaction/adjustcash

1 const url = 'https://demo.tradovateapi.com/v1/fundTransaction/adjustcash';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{"accountId":123456789,"cashChange":2500.75,"cashChangeType":"ManualAdjustment","currencyId":2}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

200Successful

1 {
2   "errorText": "",
3   "totalCashValue": 15250.75,
4   "totalPnL": 3200.5,
5   "initialMargin": 5000,
6   "maintenanceMargin": 3500,
7   "netLiq": 12000.25,
8   "openPnL": 1500,
9   "realizedPnL": 1700.5,
10   "weekRealizedPnL": 300,
11   "withdrawalRejectReason": "NoData",
12   "currencyCashAvailWithdrawalUSD": 11000,
13   "netLiqSOD": 11800,
14   "totalCashValueSOD": 15000,
15   "cashUSD": 12000.25,
16   "cashSODUSD": 11900,
17   "fullInitialMargin": 5200,
18   "fullInitialMarginSOD": 5100,
19   "autoLiqLevel": 0.15
20 }

Adjust the cash balance of a demo account.

Available to: Organization administrators

Environments: Demo

Manage the simulated fund balances of your organization’s demo accounts. Use this endpoint to top up a trader’s balance mid-challenge, set starting balances for new evaluation accounts, or reset a balance after it’s been depleted.

If your call returns a 401 “Access is denied” error, contact Evaluation Support to have the Funds:FullAccess permission added to your API key.

Difference Between adjustCash and changeDemoBalance

The changeDemoBalance endpoint is available to all traders and has rate limits to protect against abuse. Because adjustCash is restricted to organization administrators with Funds permissions, it supports higher throughput and doesn’t have a rate limit. adjustCash also gives you more control: you can classify the adjustment type, specify the currency, and include an audit comment.

Field Details

The accountId must reference an active demo account within your organization. You can look up account IDs using the Query Builder in the Admin Dashboards or via the /account/list endpoint.

The currencyId must correspond to one of the supported currencies: USD, EUR, AUD, GBP, or CAD. Currency IDs are environment-specific. Use the /currency/list endpoint to retrieve valid IDs for your environment.

Relevant cashChangeType Values

All CashChangeType enum values are accepted, but these are the most relevant for typical demo balance management:

ManualAdjustment: General-purpose balance changes
Courtesy: Goodwill credits
Debit: Deductions from an account
FundTransaction: Funding-related changes
ChallengePayout: Challenge or evaluation payouts

Common Failure Scenarios

Account is closed or inactive
accountId does not exist or does not belong to your organization
cashChange is outside the allowed range (must be between -100,000 and 100,000, exclusive)
comment exceeds 64 characters
API key is missing Funds:FullAccess scope (returns 401)
User is not an organization administrator

Reversing an Adjustment

There is no dedicated undo operation. To reverse a cash adjustment, make another adjustCash call with the opposite cashChange amount. Use the comment field to document the reason and link the reversal to the original entry.

The response includes a full CashBalanceSnapshot reflecting the account’s updated state. On success, the errorText field is absent and all balance fields are populated.

### Adjust the cash balance of a demo account. Available to: Organization administrators Environments: Demo Manage the simulated fund balances of your organization's demo accounts. Use this endpoint to top up a trader's balance mid-challenge, set starting balances for new evaluation accounts, or reset a balance after it's been depleted. <Note>If your call returns a 401 "Access is denied" error, contact Evaluation Support to have the `Funds:FullAccess` permission added to your API key.</Note> **Difference Between `adjustCash` and `changeDemoBalance`** The `changeDemoBalance` endpoint is available to all traders and has rate limits to protect against abuse. Because `adjustCash` is restricted to organization administrators with `Funds` permissions, it supports higher throughput and doesn't have a rate limit. `adjustCash` also gives you more control: you can classify the adjustment type, specify the currency, and include an audit comment. **Field Details** The `accountId` must reference an active demo account within your organization. You can look up account IDs using the Query Builder in the Admin Dashboards or via the `/account/list` endpoint. The `currencyId` must correspond to one of the supported currencies: USD, EUR, AUD, GBP, or CAD. Currency IDs are environment-specific. Use the `/currency/list` endpoint to retrieve valid IDs for your environment. **Relevant `cashChangeType` Values** All `CashChangeType` enum values are accepted, but these are the most relevant for typical demo balance management: - `ManualAdjustment`: General-purpose balance changes - `Courtesy`: Goodwill credits - `Debit`: Deductions from an account - `FundTransaction`: Funding-related changes - `ChallengePayout`: Challenge or evaluation payouts **Common Failure Scenarios** - Account is closed or inactive - `accountId` does not exist or does not belong to your organization - `cashChange` is outside the allowed range (must be between -100,000 and 100,000, exclusive) - `comment` exceeds 64 characters - API key is missing `Funds:FullAccess` scope (returns 401) - User is not an organization administrator **Reversing an Adjustment** There is no dedicated undo operation. To reverse a cash adjustment, make another `adjustCash` call with the opposite `cashChange` amount. Use the `comment` field to document the reason and link the reversal to the original entry. <Note> The response includes a full `CashBalanceSnapshot` reflecting the account's updated state. On success, the `errorText` field is absent and all balance fields are populated. </Note>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

accountIdlongRequired

cashChangedoubleRequired<=100000

cashChangeTypeenumRequired

AccountClosureFee, AddUserFee, AutomaticReconciliation, BrokerageFee, CancelledPairedTrade, CashSettlement, ChallengePayout, ClearingFee, Commission, Courtesy, CurrencyConversion, CurrencyConversionFee, Debit, DepositFee, DeskFee, DormantFee, EntitlementSubscription, Escheatment, ExchangeFee, FundTransaction, FundTransactionFee, FundingRate, GoodwillCredit, IPFee, InactivityFee, LiquidationFee, LiquidationFee2, ManualAdjustment, MarketDataSubscription, NewSession, NfaFee, NsfCheckFee, OptionsTrade, OrderRoutingFee, PROMO, RithmicFee, SeatLeasePayment, StopPaymentFee, SwapTrade, ThirdPartyFee, TradePaired, TradovateSubscription

currencyIdlongRequired

commentstringOptional<=64 characters

senderIdlongOptional

Response

CashBalanceSnapshot

errorTextstring<=8192 characters

Non-empty if the request failed

totalCashValuedouble

totalPnLdouble

initialMargindouble

maintenanceMargindouble

netLiqdouble

openPnLdouble

realizedPnLdouble

weekRealizedPnLdouble

withdrawalRejectReasonenum

NoData, PendingContactInfoChange

currencyCashAvailWithdrawalUSDdouble

netLiqSODdouble

totalCashValueSODdouble

cashUSDdouble

cashSODUSDdouble

fullInitialMargindouble

fullInitialMarginSODdouble

autoLiqLeveldouble