API product catalogDeveloper Platform, Sandbox & Key Management

Credit virtual funds

Developer Platform, Sandbox & Key Management

POST

/test-tools/deposit

Sandbox availablecreateTestToolsDeposit

Credits virtual USD to a sandbox sub-account for deterministic integration testing. New integrations use the sandbox base with an sk_sandbox_ key. Production-base access is restricted legacy compatibility for specifically approved partners. No real money moves. Maximum $1,000,000 per call. Triggers a deposit.confirmed webhook if one is registered. Formerly POST /sandbox/deposit, which remains a deprecated alias.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Request body

subAccountIdstringRequired

MyStocks sub-account ID to credit. Must belong to your partner key.

Example: "usr_test_abc123"

amountnumberRequired

Virtual USD to credit. No real funds move. Max 1,000,000.

Example: 10000

notestring

Optional label shown in the admin log and the deposit.confirmed webhook payload.

Response fields

messagestring

walletBalancenumber

transactionIdstring

Response codes

200Virtual funds credited.

Request reference

Sandbox available

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/sandbox/v1/partner/test-tools/deposit

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "walletBalance": {
      "type": "number"
    },
    "transactionId": {
      "type": "string"
    }
  }
}

curl -X POST 'https://mystocks.africa/api/sandbox/v1/partner/test-tools/deposit' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "subAccountId": "usr_abc123",
  "amount": 1000
}'

POST /settings

GET /test-tools/orders