otc

Cancel OTC Trade

Cancel a pending OTC trade or reject an OTC trade previously submitted on your behalf by an inter-dealer broker.

Submits a command to the trading engine. A successful response indicates that the command entry was acknowledged but does not indicate that the command was executed. This endpoint uses the signing format which does not require strict field ordering and addition of null fields in the request body.

Command schemas and examples are provided below. Supported commands:

  • V1CancelOtcTrade
  • V1CancelAllOtcTrades

Requires

  • bearer token in authorization header
post/v2/otc-command#cancel

Request

Headers

BX-SIGNATUREstring required

signature obtained using the signing format

BX-TIMESTAMPstring required

timestamp is the number of milliseconds since EPOCH

BX-NONCEstring required

nonce is a client side incremented unsigned 64 bit integer

Request body

OR

Example request

{
  "commandType": "V1CancelOtcTrade",
  "clientOtcTradeId": "20050900225",
  "tradingAccountId": "111000000000001"
}

Response

Status OK. This means a command was successfully acknowledged.

OR

Example response

{
  "message": "Command acknowledged - CancelOtcTrade",
  "requestId": "100000000000000147",
  "otcTradeId": "200000000000000098",
  "tradingAccountId": "111000000000001"
}

Changes

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