Cancel Order
Cancel a specified order.
API Information
- Method:
DELETE - Path:
/api/v1/orders/{id} - Authentication: Requires signature authentication (see Common Module · Signature Specification)
Request Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | Yes | Order ID |
Request Example
DELETE /api/v1/orders/1234567890123456789
Response Fields
| Field | Type | Description |
|---|---|---|
| code | integer | Status code, 0 indicates success |
| message | string | Response message |
| data.order_id | string | Order ID |
| data.cancel_id | string | Cancel ID |
| data.client_cancel_id | string | Client cancel ID |
Response Example
{
"code": 0,
"message": "success",
"data": {
"order_id": "1234567890123456789",
"cancel_id": "1234567890123456789",
"client_cancel_id": "my-cancel-001"
}
}