Skip to content

Cancel Order

Endpoint Information

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

Description: Cancel an unfilled order

Authentication: Authorization header with JWT token

Request Parameters

FieldTypeRequiredDescription
order_iduuidYesOrder ID (route parameter)

Response Parameters

FieldTypeDescription
successboolWhether cancellation succeeded
order_iduuidOrder ID
messagestringResult description

Request Example

bash
curl -X POST "/api/v1/orders/550e8400-e29b-41d4-a716-446655440000/cancel" \
     -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
     -H "Content-Type: application/json"

Response Example

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