Skip to main content
POST
/
v1
/
chains
/
{chain_name}
/
orders
/
cancel
Cancel one or more orders
curl --request POST \
  --url https://api.sandbox.immutable.com/v1/chains/{chain_name}/orders/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
  "ids": [
    "018a8c71-d7e4-e303-a2ef-318871ef7756",
    "238a8c71-d7e4-e303-a2ef-318871ef7778",
    "458a8c71-d7e4-e303-a2ef-318871ef7790"
  ],
  "signature": 291
}
'
{
  "result": {
    "successful_cancellations": [
      "018a8c71-d7e4-e303-a2ef-318871ef7756",
      "458a8c71-d7e4-e303-a2ef-318871ef7778"
    ],
    "pending_cancellations": [
      "238a8c71-d7e4-e303-a2ef-318871ef7778",
      "898a8c71-d7e4-e303-a2ef-318871ef7735"
    ],
    "failed_cancellations": [
      {
        "order": "458a8c71-d7e4-e303-a2ef-318871ef7790",
        "reason_code": "FILLED"
      },
      {
        "order": "338a8c71-d7e4-e303-a2ef-318871ef7342",
        "reason_code": "FILLED"
      }
    ]
  }
}

Path Parameters

​
chain_name
string
required

The name of chain

Example:

"imtbl-zkevm-testnet"

Body

application/json
​
account_address
string
required

Address of the user initiating the cancel request

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"

​
orders
string<uuid>[]
required

List of order ids proposed for cancellation

Required array length: 1 - 20 elements
​
signature
string
required

Signature generated by the user for the specific cancellation request

Example:

"0x12345"

Response

Orders cancellation response.

​
result
object
required