API product catalogSub-Accounts & White-Label Retail KYC

Cancel sub-account order

Sub-Accounts & White-Label Retail KYC

DELETE

/users/{userId}/orders/{orderId}

Sandbox availabledeleteUsersUserIdOrdersOrderId

Cancels an active PENDING or WORKING order on a sub-account and releases reserved cash or units. Available in production and sandbox; terminal orders return a conflict/error response.

Parameters

userIdstringpathRequired

Example: usr_abc123

orderIdstringpathRequired

Example: ord_abc123xyz

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

Response fields

orderIdstring

subAccountIdstring

externalIdstring | null

typeBUY | SELL

symbolstring

quantitynumber

statusCANCELLED

refundednumber

USD amount returned to sub-account wallet. Present for BUY orders only.

currencystring

Example: "USD"

messagestring

Response codes

200Order cancelled. BUY escrow refunded to sub-account wallet atomically.

409Order cannot be cancelled — it is no longer PENDING.

Request reference

Sandbox available

userId Required · pathorderId Required · path

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

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string"
    },
    "subAccountId": {
      "type": "string"
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "BUY",
        "SELL"
      ]
    },
    "symbol": {
      "type": "string"
    },
    "quantity": {
      "type": "number"
    },
    "status": {
      "type": "string",
      "enum": [
        "CANCELLED"
      ]
    },
    "refunded": {
      "type": "number",
      "description": "USD amount returned to sub-account wallet. Present for BUY orders only."
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "message": {
      "type": "string"
    }
  }
}

curl -X DELETE 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/orders/%7BorderId%7D' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID"

GET /users/{userId}/orders

GET /users/{userId}/orders/{orderId}