Skip to content
MyStocks Developers
API v1

API v1

Current stable contract

Versioning policyRelease changelog
Sandbox console
Operate

Hosted API operational handoff

Coordinate hosted approval, funding, execution, payouts and reconciliation with MyStocks operations.

How does my trading app connect to MyStocks operations?

Sandbox is an isolated simulation. Hosted Live approval, API credentials, installation licensing and external settlement are separate states. A successful Sandbox journey never approves a production organization or moves real funds.

Partner actionAdmin taskShared state and evidence
Submit hosted applicationReview identity and business, approve the organization and production accessApplication and organization status, authorized decision, notification and audit
Remit firm fundingMatch payment reference, currency and actual receipt before crediting floatOne canonical ledger credit, reference, reviewer and available firm balance
Fund a customerReview exceptions and available firm floatAtomic firm-to-customer transfer, customer wallet and ledger entries
Submit a stock orderReview partner-attributed order in /admin/dealing-roomOrder ID, partner business name, reserved cash/units, executions and remainder
Subscribe to a fund or bondReview the corresponding pending investment order and allocationReserved USD, NAV/FX, approved allocation, holding and transaction
Return customer cash to firmReview account restrictions and settlement holdsCustomer debit and firm credit; this is not an external payout
Request an external payoutAuthorize treasury decision and confirm provider outcomeBeneficiary, reserved amount, approval, provider reference and ledger
Reconcile a periodCompare the canonical ledger with independent payment/custody recordsAs-of period, discrepancies, evidence and signed review
Report a delivery problemReview webhook attempts and an owned support caseEvent ID, signature, retries, communication and audit

What should I show my customer while an order is pending?

Show the actual API order status, reserved balance and filled versus remaining quantity. Request acceptance is not execution. A fill is not independent settlement. Do not enable withdrawals against unsettled proceeds when settlement holds apply. Use event IDs and idempotent handlers; reconnect an event stream with its last event ID.

How do I safely retry money movement?

Use the same canonical subAccountId, endpoint, payload and Idempotency-Key for the same logical operation. A changed payload is a new intent and must not be retried under the old key. Inspect wallet, order and ledger state before resolving an uncertain outcome. Use canonical IDs consistently even when an external-ID alias is supported.

Can a closed account be reopened?

No. A closed account is terminal and cannot be changed back to active through metadata updates. Frozen accounts can be restored through the authorized lifecycle. Money-moving handlers recheck ownership and active state inside their transaction. Create a new account for a new customer relationship; retain the old account's records for review.

What evidence completes an acceptance test?

Partner action → admin task → authorized decision → shared state → notification → audit evidence → automated test. Email queue insertion proves notification intent, not inbox delivery. Dealing-room tests prove the internal handoff, not execution at an external exchange. A reconciliation response without independent custody/payment data remains incomplete.

Operations can use admin readiness to find required decisions and their workspaces. Production-only checks need an isolated approved test integration; the public Sandbox reference app does not execute treasury or dealing-room decisions.

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

On this page