Skip to main content
POST
/
v1
/
orders
/
{request_id}
/
abort
Abort Order
curl --request POST \
  --url https://api.zinc.io/v1/orders/{request_id}/abort \
  --header 'Authorization: Basic <encoded-value>'
{
  "_type": "error",
  "code": "aborted_request",
  "message": "<string>",
  "data": {},
  "request_id": "<string>",
  "request": {}
}
The Zinc API allows you to abort orders that are still in the request_processing stage. This functionality is intended to abort an order if was made by mistake or if it is taking too long to process. The response will be the same as if you were to GET the order. If we were able to immediately abort the order, the order will have an error code of aborted_request. It can take time for an order to abort and success is not guaranteed. You can either periodically poll the order to check if it was aborted or use webhooks.

Authorizations

​
Authorization
string
header
required

Use your client token as the username. Leave the password blank.

Path Parameters

​
request_id
string
required

The unique identifier for the order request to abort

Response

Order abort response

​
_type
enum<string>

Response type

Available options:
error
​
code
enum<string>

Error code

Available options:
aborted_request,
request_processing
​
message
string

Error message

​
data
object

Additional error data

​
request_id
string

The unique identifier for the order request

​
request
object

The original request that was sent to the Zinc API

⌘I