Skip to content

Order modification result

SEND Server to Client on wss://api.valr.com/ws/account

Sent when an order modification request has been processed. Indicates whether the modification was successful and includes the modification request ID for correlation with the original MODIFY_ORDER command.

Authentication

This operation requires API key authentication (HMAC-SHA512 via query parameters or in-band AUTHENTICATE message).

Message

Event type: MODIFY_ORDER_OUTCOME

Payload Schema

PropertyTypeRequiredDescription
successbooleanYes-
orderIdstringYes-
customerOrderIdstringNo-
modifyRequestIdstringYes-

Example

json
"{\n    \"type\": \"MODIFY_ORDER_OUTCOME\",\n    \"data\": {\n        \"success\": true,\n        \"orderId\": \"019a29d0-4362-7dc9-a51d-3533a4bdcf2d\",\n        \"customerOrderId\": \"testWS\",\n        \"modifyRequestId\": \"019a2a0f-1216-737b-9065-8138dae1e874\"\n    }\n}"

Channel

Channel: account Address: wss://api.valr.com/ws/account