Cancel Order

Endpoint Information

Endpoint: POST /api/v1/orders/{order_id}/cancel

Description: Cancel an unfilled order

Authentication: API Key + Signature. See Authorization

Note: This is a Maker API endpoint. The X-Maker-Addr header is required and must be included in both the request headers and signature string.

Request Parameters

Field	Type	Required	Description
order_id	uuid	Yes	Order ID (route parameter)

Response Parameters

Field	Type	Description
success	bool	Whether cancellation succeeded
order_id	uuid	Order ID
message	string	Result description

Request Example

curl -X POST "{API_BASE_URL}/api/v1/orders/550e8400-e29b-41d4-a716-446655440000/cancel" \
     -H "X-API-Key: YOUR_API_KEY" \
     -H "X-Maker-Addr: YOUR_MAKER_ADDRESS" \
     -H "X-API-Timestamp: 1715100000000" \
     -H "X-API-Signature: GENERATED_SIGNATURE" \
     -H "Content-Type: application/json"

Response Example

{
    "code": 0,
    "data": {
        "success": true,
        "order_id": "550e8400-e29b-41d4-a716-446655440000",
        "message": "Order cancelled successfully"
    }
}