Order Status

Returns the lifecycle state of a submitted order: pending while it progresses, then the terminal settled or failed. The same transitions arrive as WebSocket events (order.created, order.settled, order.failed) on the orders: topic. Because settlement is delivery-versus-payment, failed never means lost funds - the escrowed input follows the refund path.

GET /orders/{id}

Order Status

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/router/orders/{id} \
  --header 'X-API-Key: <api-key>'

200

{
  "txHash": "<string>",
  "settledAmounts": {},
  "failure": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key · string · header · required

Service-account API key (tfk_test_/tfk_live_).

Path Parameters

id · string · required

Order identifier returned by POST /orders.

Response

200

application/json

Successful Response

status · enum<string> · required

Order lifecycle state. pending - accepted and progressing; settled - delivery proven and funds released (terminal); failed - could not settle before expiry, the escrowed input follows the refund path (terminal). The same transitions are pushed over WebSocket as order.created, order.settled, and order.failed on the orders:{id} topic.

Available options: pending, settled, failed

txHash · string | null

Settlement transaction hash - present once a settlement transaction has been broadcast.

settledAmounts · Settledamounts · object | null

Delivered amounts keyed by asset, present once the order settles.

Show child attributes

failure · Failure · object | null

Populated on failed orders; the escrowed input follows the refund path.

Show child attributes