BUbullish
idb

IDB Update Remarks

Update the IDB remarks of a previously initiated OTC trade.

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:

  • V1IdbUpdateRemarks

  • requires bearer token in authorization header

post/v2/idb/otc-command#update-remarks

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

commandTypestring required

Specifies the command type and must be 'V1IdbUpdateRemarks' to indicate the update of IDB remarks for a dual-sided OTC trade

sharedMatchKeystring required

Unique shared key that is agreed between the two customers to represent their OTC trade to be matched on Bullish's OTC Clearing Facility. Must be a 12 to 64 characters alphanumeric value

idbRemarksstring required

text field for IDB's internal reference to a trade, max length is 255 characters

Example request

{
  "commandType": "V1IdbUpdateRemarks",
  "sharedMatchKey": "a40d0c302d0448ce8e144c8312dd6ef0",
  "idbRemarks": "resubmitted by xyz"
}

Response

Status OK. This means a command was successfully acknowledged.

messagestring required

message indicating the status of the request

sharedMatchKeystring required

system-generated unique identifier for the dual-sided brokered OTC trade

Example response

{
  "message": "Command acknowledged - IdbUpdateRemarks",
  "sharedMatchKey": "a40d0c302d0448ce8e144c8312dd6ef0",
  "maker": {
    "requestId": "100000000000000147",
    "otcTradeId": "200000000000000098"
  },
  "taker": {
    "requestId": "100000000000000148",
    "otcTradeId": "200000000000000099"
  }
}

Changes

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