Skip to main content
POST
Builds a transaction that cancels an open order and returns the escrowed assets to the caller. Pass the order reference as txHash plus index, then provide changeAddress and utxos. For utxos, use "splash-wallet" to let the builder resolve wallet inputs automatically, or pass string[] to provide serialized UTxOs yourself. See UTxO input modes for the difference. Auth: Public

Request body

string
required
Transaction hash of the order to cancel.
string
required
Output index of the order within its transaction, encoded as a string.
string
required
Bech32 change address.

Response

string
Builder transaction ID.
string
Hex-encoded transaction CBOR. It is signed when collaterals are omitted.
boolean
Whether the returned transaction is still partial. The current implementation returns true.

Error response

string
Machine-readable error code.
string
Human-readable error message.
Possible errors:
  • 400 INVALID_PARAMS — one or more required fields are missing or have the wrong type.
  • 500 SERVER_ERROR — UTxO lookup, config loading, transaction building, or optional signing failed.