Cancel order

Cancel order

post

Description: Cancel trading bridge order

group=tradeApi 
version=0.0.1 
bizType=tradeapi.admin.OrderAdminApiService.cancelDirectOrder 

Header parameters

companyIdstringRequired

Company ID

Example: {{company}}

tracestringRequired

Global link unique identifier

Example: {{mock_trace}}

apiKeystringRequired

apiKey

Example: {{apikey}}

recvWindowstringOptional

time window

Example: 5000

signaturestringRequired

sign

Example: {{sign}}

langstringOptional

language

Example: zh-CN

versionstringRequired

Interface version

Example: 0.0.1

groupstringRequiredExample: tradeApi

Body

application/json

tradeTypeinteger · longRequired

Game type. 10-Transaction Bridge;

exchangeIdstringRequired

Platform identifier. binance-Binance; okx-OUYi

accountNamestringRequired

Platform account alias

customerIdinteger · longOptional

CustomerId

customerNostringRequired

Customer code

customerGroupIdinteger · longRequired

Customer group ID

symbolIdinteger · longRequired

ProductId

orderIdstringOptional

Platform order number. Select one of newClientOrderId and fill in both with orderId to query

clientOrderIdstringOptional

Customer-defined unique order ID. Select one of orderId, fill in both with orderId to query

Responses

200Success

application/json

bizCodestringOptional

Module identification code

codestringOptional

status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

tracking code

msgParamsstringOptional

Returns the placeholder parameter string in the description. Multiple parameters are separated by,

okbooleanOptional

Is the response successful?

failbooleanOptional

Whether the response failed

post

/global/tradeapi.admin.OrderAdminApiService.cancelDirectOrder

HTTPcURLJavaScriptPython

POST /global/tradeapi.admin.OrderAdminApiService.cancelDirectOrder HTTP/1.1
companyId: text
trace: text
apiKey: text
signature: text
version: text
group: text
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "tradeType": 1,
  "exchangeId": "text",
  "accountName": "text",
  "customerId": 1,
  "customerNo": "text",
  "customerGroupId": 1,
  "symbolId": 1,
  "orderId": "text",
  "clientOrderId": "text"
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": {
    "exchangeId": "text",
    "orderId": "text",
    "clientOrderId": "text"
  }
}