Sign in
swap

Cancel a pending swap order. (admin access required, mainnet only)

Cancel a pending SundaeSwap order that is sitting at the script address. Only orders in OrderConfirmed state can be cancelled.

post/swap/cancel

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/swap/cancel
  • Auth: API key in header token

Request body

walletVkeystring required

Wallet verification key (vKey) of the wallet that placed the order

swapTransactionIdstring required

ID of the SwapTransaction to cancel

Example request

{
  "walletVkey": "wallet_verification_key_here",
  "swapTransactionId": "clx1abc..."
}

Response

Cancel transaction submitted

cancelTxHashstring required

Transaction hash of the cancel transaction

Example response

{
  "cancelTxHash": "abc123def456..."
}

Changes

No recorded changes to this operation across all 50 revisions of this API.