Get Order Status

Returns the current status of the order.

GET /v1/orders/{order_id}/status

Get Order Status

cURL

curl --request GET \
  --url https://sandbox.api.rime.finance/v1/orders/{order_id}/status \
  --header 'Authorization: Bearer <token>'

200

pending_status

{
  "status": "AWAITING_PAYMENT"
}

Authorizations

Authorization · string · header · required

Bearer access token. Provide as a Authorization: Bearer <token> header.

Path Parameters

order_id · string<uuid> · required

Response

200 - application/json

Order status retrieved successfully

status · enum<string> · required

Status the order is currently in. This status is updated by the system depending on the order's lifecycle state.

Buy order flow: PLACED → AWAITING_PAYMENT → PAYMENT_RECEIVED → EXECUTED → DELIVERY_INITIATED → DELIVERY_COMPLETED → COMPLETED

Sell order flow: PLACED → REDEMPTION_GATED (if locked) → EXECUTED → PAYMENT_SENT → PAYMENT_COMPLETED → COMPLETED

Orders can be CANCELLED from non-terminal states.

Available options: PLACED, AWAITING_PAYMENT, PAYMENT_RECEIVED, DELIVERY_INITIATED, DELIVERY_COMPLETED, PAYMENT_SENT, PAYMENT_COMPLETED, REDEMPTION_GATED, EXECUTED, COMPLETED, CANCELLED

order_url · string | null

URL to the order resource, provided when order is completed.