Sign in
banking.v1.BookService

CancelOrder

Take the caller's resting order off the book; its unspent escrow is released. Idempotent on an already-cancelled order; a filled one is ALREADY_EXISTS.

post/banking.v1.BookService/CancelOrder

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

order_idstring

Response

Success

idstring
servicestring
user_idstring
sidestring

buy | sell

kindstring

limit | market

tifstring

gtc | ioc | alo

pricestring

decimal USDT per unit

sizestring

decimal units

filledstring

decimal units

remainingstring

decimal units (size − filled)

avg_fill_pricestring

decimal USDT per unit; empty until the first fill

fee_paidstring

decimal USDT the caller paid as taker on this order

statestring

open | partially_filled | filled | cancelled | rejected

reject_reasonstring

free text; set exactly when state = rejected

client_order_idstring
cancel_reasonstring

Set exactly when state = cancelled: "" | user | ioc_remainder | market_remainder. user is the owner's own cancel; the other two are the hub cancelling what an IOC limit / a market order could not fill at once — such an order may still show filled > 0, which is what makes the reason worth carrying.

Changes

No recorded changes to this operation across all 1 revision of this API.