API product catalogExecution & Order Management (OMS)

Preflight a sub-account trade

Execution & Order Management (OMS)

GET

/users/{userId}/preflight

Sandbox availablegetTradePreflight

Side-effect-free eligibility check combining account and KYC status, market session, indicative pricing, buying power or holdings, estimated fees, and settlement expectations. Obtain a firm quoteId after this check passes and before submitting the order.

Parameters

userIdstringpathRequired

Example: usr_abc123

symbolstringqueryRequired

Example: SCOM.KE

typeBUY | SELLqueryRequired

quantitynumberqueryRequired

Example: 10

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

eligiblebooleanRequired

blockingReasonsobject[]Required

blockingReasons[].codestringRequired

blockingReasons[].messagestringRequired

accountobjectRequired

marketobjectRequired

quoteobjectRequired

buyingPowerobjectRequired

settlementobjectRequired

nextStepstringRequired

Response codes

200Consolidated trade eligibility result.

400Invalid symbol, side, or quantity.

404Sub-account or symbol not found.

Sandbox playground

Read-only sandbox request

userId Required · pathsymbol Required · querytype Required · queryquantity Required · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/preflight

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "eligible",
    "blockingReasons",
    "account",
    "market",
    "quote",
    "buyingPower",
    "settlement",
    "nextStep"
  ],
  "properties": {
    "eligible": {
      "type": "boolean"
    },
    "blockingReasons": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "account": {
      "type": "object",
      "additionalProperties": true
    },
    "market": {
      "type": "object",
      "additionalProperties": true
    },
    "quote": {
      "type": "object",
      "additionalProperties": true
    },
    "buyingPower": {
      "type": "object",
      "additionalProperties": true
    },
    "settlement": {
      "type": "object",
      "additionalProperties": true
    },
    "nextStep": {
      "type": "string"
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/preflight' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

POST /trade

Sub-Accounts & White-Label Retail KYC