Cancel Orders
ordercancel orderscancel crypto orders
Describes how to cancel orders in Spell.
After an order has been created, users can cancel pending orders through the web interface or by making an API request.
API Documentation
Cancel an Order
Only orders with a Pending Payment status (status=0
) can be canceled.
Preparation
Before making a request, you need to prepare the following:
- Get the ID of the order you want to cancel. This can be done by querying orders or by recording the ID when the order is created.
Note: The order ID (
id
) is not the order number (order_no
).
Request
POST /api/v1/order/cancel
- Headers:
X-API-Key: '<API Key>'
X-Signature: '<SIGNATURE>'
(please refer to: API Keys.)
- Request Parameters:
Parameter | Type | Required | Parameter Description |
---|---|---|---|
id | string | Yes | The order ID |
Response
Success 200
{
"code": 200,
"message": "success"
}
Fail 400
{
"code": 400,
"message": "error message"
}