Skip to content

Instant order completed

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

Sent when a simple buy/sell (instant) order has been completed. Includes the amounts paid and received, fees, and whether the order was successful.

Authentication

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

Message

Event type: INSTANT_ORDER_COMPLETED

Payload Schema

PropertyTypeRequiredDescription
orderIdstringYes-
successbooleanYes-
paidAmountstringNo-
paidCurrencystringNo-
receivedAmountstringNo-
receivedCurrencystringNo-
feeAmountstringNo-
feeCurrencystringNo-
orderStatusTypestringNo-
failedReasonstringNo-

Example

json
"{\n    \"type\": \"INSTANT_ORDER_COMPLETED\",\n    \"data\": {\n        \"orderId\": \"f1e2d3c4-b5a6-7890-1234-567890abcdef\",\n        \"success\": true,\n        \"paidAmount\": \"10000.00\",\n        \"paidCurrency\": \"ZAR\",\n        \"receivedAmount\": \"0.01050000\",\n        \"receivedCurrency\": \"BTC\",\n        \"feeAmount\": \"100.00\",\n        \"feeCurrency\": \"ZAR\",\n        \"orderStatusType\": \"Filled\",\n        \"failedReason\": null\n    }\n}"

Channel

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