Cancel order

POST 
/cancel-order

Cancels an existing order after 5 minutes by expiring it.

warning

Authenticate by signing the request or with the legacy x-sideshift-secret header. Your Ed25519 secret key and your account secret each grant full access to your account. Never share them.

Request

Header Parameters

x-sideshift-key string

Your Ed25519 public key, hex encoded. Required when signing the request. See Authentication.

x-sideshift-timestamp string

Current Unix time in milliseconds, the same value used in the signed message. Must be within 60 seconds of server time. Required when signing the request.

x-sideshift-signature string

Ed25519 signature of timestamp + METHOD + path + body, hex encoded. Required when signing the request. See Authentication.

x-sideshift-secret string

Legacy account secret. Not needed when the request is signed with the x-sideshift-key, x-sideshift-timestamp and x-sideshift-signature headers. See Authentication.

application/json

Body

required

orderIdstringrequired

The unique identifier of the order to cancel

Responses

204

Order successfully cancelled

400

Bad Request

application/json

Schema

Schema

error object
messagestringrequired
codestringrequired
orderIdstring
depositRangeMinstring
depositRangeMaxstring

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
messagestringrequired
codestringrequired
orderIdstring
depositRangeMinstring
depositRangeMaxstring

Example

{
  "error": {
      "message": "Authentication required: sign the request or send the x-sideshift-secret header",
      "code": "FORBIDDEN"
  }
}

500

Internal Server Error

application/json

Schema

Schema

error object
messagestringrequired
codestringrequired
orderIdstring
depositRangeMinstring
depositRangeMaxstring

Example

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