API product catalogExecution & Order Management (OMS)

Cancel order

Execution & Order Management (OMS)

DELETE

/orders/{orderId}

Cancel order

Sandbox unsupporteddeleteOrders

Cancels a PENDING order. Returns 422 if the order has already been settled or rejected.

Parameters

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

statusCANCELLED

refundednumber

USD amount returned to master wallet. Present for BUY orders only.

currencystring

Example: "USD"

messagestring

Response codes

200Order cancelled. BUY escrow refunded atomically.

409Order cannot be cancelled — it is no longer PENDING or WORKING (already PROCESSING, COMPLETED, or REJECTED).

Request reference

Sandbox unsupported

orderId Required · path

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

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "CANCELLED"
      ]
    },
    "refunded": {
      "type": "number",
      "description": "USD amount returned to master wallet. Present for BUY orders only."
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "message": {
      "type": "string"
    }
  }
}

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

GET /orders

GET /orders/{orderId}