Skip to main content
GET
/
v1
/
orders
/
{id}
/
stream
Stream Order Status
curl --request GET \
  --url https://api.example.com/v1/orders/{id}/stream
Subscribe to an open event stream to receive live, sub-second status changes of a conversion order. Useful for merchant checkout screens and PWAs to advance their UI automatically once payment lands in escrow.

Path Parameters

id
string
required
The unique UUID ID of the order.

Response

This endpoint streams Server-Sent Events (SSE) using the text/event-stream MIME type. Each message contains a JSON-serialized order object under the data: prefix:
event: message
data: {"order_id":"ord_abc123","status":"deposited"}

event: message
data: {"order_id":"ord_abc123","status":"settled"}