Cancel order

POST 
/cancel-order

Cancels an existing order after 5 minutes by expiring it.

warning

x-sideshift-secret is your account's private key. Never share it with anyone as it grants full access to your account and should be kept confidential.

Request

Header Parameters

x-sideshift-secret stringrequired

application/json

Body

required

orderId stringrequired

The unique identifier of the order to cancel

Responses

204

Order successfully cancelled

400

Bad Request

application/json

Schema

Schema

error object
message stringrequired
code stringrequired
orderId string
depositRangeMin string
depositRangeMax string

Example

{
  "error": {
      "message": "Order already expired",
      "code": "BAD_USER_INPUT"
  }
}

{
  "error": {
      "message": "Orders can only be cancelled after 5 minutes.",
      "code": "BAD_USER_INPUT"
  }
}

404

Not Found

application/json

Schema

Schema

error object
message stringrequired
code stringrequired
orderId string
depositRangeMin string
depositRangeMax string

Example

{
  "error": {
      "message": "Incorrect or missing "x-sideshift-secret" header",
      "code": "FORBIDDEN"
  }
}

500

Internal Server Error

application/json

Schema

Schema

error object
message stringrequired
code stringrequired
orderId string
depositRangeMin string
depositRangeMax string

Example

{
  "error": {
      "message": "Internal Server Error",
      "code": "UNKNOWN"
  }
}

Loading...