Skip to main content
POST
/
cancel
curl --request POST \
  --url https://builder.snek.fun/cancel \
  --header 'Content-Type: application/json' \
  --data '{
    "txHash": "e2ed9e953ebf98ca701fc93588d73cb9769f87b9d13712474f566a0743963e8b",
    "index": "0",
    "changeAddress": "addr1...",
    "utxos": "splash-wallet"
  }'
{
  "id": "cancel-01...",
  "cbor": "84a500...",
  "partial": true
}
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

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

Response

id
string
Builder transaction ID.
cbor
string
Hex-encoded transaction CBOR. It is signed when collaterals are omitted.
partial
boolean
Whether the returned transaction is still partial. The current implementation returns true.
curl --request POST \
  --url https://builder.snek.fun/cancel \
  --header 'Content-Type: application/json' \
  --data '{
    "txHash": "e2ed9e953ebf98ca701fc93588d73cb9769f87b9d13712474f566a0743963e8b",
    "index": "0",
    "changeAddress": "addr1...",
    "utxos": "splash-wallet"
  }'
{
  "id": "cancel-01...",
  "cbor": "84a500...",
  "partial": true
}

Error response

cause
string
Machine-readable error code.
message
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.
{
  "cause": "INVALID_PARAMS",
  "message": "Invalid input"
}