API product catalogSub-Accounts & White-Label Retail KYC

Read up to 20 customer wallet summaries

Sub-Accounts & White-Label Retail KYC

GET

/users/summary

Sandbox availablegetCustomerWalletSummaries

Supply 1–20 distinct owned customer IDs or external IDs, separated by commas. Unknown and foreign IDs return the same NOT_FOUND item error. Actual currency wallets, USD buying power and currency closure blockers are returned per account. Accounts are read independently, not as an atomic consolidated statement. Open orders, positions and settlements still require closure-time checks.

Parameters

userIdsstringqueryRequired

1–20 distinct comma-separated customer IDs or external IDs.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

accountsobject[]Required

accounts[].requestedIdstring

accounts[].subAccountIdstring

accounts[].userIdstring

accounts[].externalIdstring

accounts[].statusstring

accounts[].asOfstring

accounts[].currencyWalletsobject[]

accounts[].buyingPowerobject

accounts[].currencyClosureBlockersobject[]

accounts[].errorobject

countintegerRequired

asOfstringRequired

snapshotModelstringRequired

sandboxboolean

Response codes

200Owned customer results with explicit read and continuation limits.

400Invalid bounds, identifiers or cursor.

401Valid environment-specific API key required.

403Required read permission is missing.

429Partner request rate limit exceeded.

Sandbox playground

Read-only sandbox request

userIds Required · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/users/summary

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "accounts",
    "count",
    "asOf",
    "snapshotModel"
  ],
  "properties": {
    "accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "requestedId": {
            "type": "string"
          },
          "subAccountId": {
            "type": "string"
          },
          "userId": {
            "type": "string"
          },
          "externalId": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          },
          "currencyWallets": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "buyingPower": {
            "type": "object",
            "additionalProperties": true
          },
          "currencyClosureBlockers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "currency": {
                  "type": "string"
                },
                "reason": {
                  "type": "string"
                },
                "nextAction": {
                  "type": "string"
                }
              }
            }
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "NOT_FOUND"
                ]
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "asOf": {
      "type": "string",
      "format": "date-time"
    },
    "snapshotModel": {
      "type": "string",
      "const": "PER_ACCOUNT_READS_NOT_ATOMIC_BATCH"
    },
    "sandbox": {
      "type": "boolean"
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/summary' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

POST /users/{userId}/withdraw

Treasury, Cash Management & FX Settlement