The partner aggregates their end-users' deposits and remits to the master account (POST /topup); the master wallet funds sub-account deposits. This returns the funding headroom so the partner knows when to remit: masterBalanceUsd, pending top-ups, any credit line, availableToFundUsd, and a floatStatus of HEALTHY / LOW / DEPLETED / ON_CREDIT. Pair with the float.low and topup.confirmed webhooks.
Parameters
This endpoint has no path or query parameters.
Headers
AuthorizationstringRequired
Bearer sk_sandbox_<your_key> for sandbox requests.
Response fields
currencystring
Example: "USD"
masterBalanceUsdnumber
Current master wallet balance (negative when drawn on the credit line).
reservedCashUsdnumber
Cash unavailable for spending
completenessobject
completeness.completeboolean
completeness.warningsstring[]
pendingTopupsUsdnumber
Sum of PENDING top-up requests awaiting MyStocks confirmation.
pendingPayoutsUsdnumber
Sum of PENDING payout requests awaiting MyStocks processing.
creditLimitUsdnumber
Credit line — how far the master balance may go negative while a remittance is in flight (MyStocks-set; 0 = pre-funded only).
outstandingCreditUsdnumber
Credit currently drawn (present when masterBalanceUsd is negative).
availableToFundUsdnumber
Cash balance less reservations, plus approved credit only when there are no cash reservations.
lowBalanceThresholdUsdnumber
Master balance below which a float.low webhook fires (partner-set via PATCH /float).
minimumFloatUsdnumber
Partner treasury policy floor for the master account.