Type Alias CancelTransactionResponse

type CancelTransactionResponse = {
    approvalId?: string;
    dateBroadcasted?: string;
    dateConfirmed?: string;
    datePolicyResolved?: string;
    dateRequested: string;
    details?: { [x: string]: unknown };
    externalId?: string;
    fee?: string;
    id: string;
    network:
        | "Algorand"
        | "AlgorandTestnet"
        | "Aptos"
        | "AptosTestnet"
        | "ArbitrumOne"
        | "ArbitrumGoerli"
        | "ArbitrumSepolia"
        | "Arc"
        | "ArcTestnet"
        | "Areum"
        | "AvalancheC"
        | "AvalancheCFuji"
        | "Adi"
        | "AdiTestnet"
        | "AdiTestnetAb"
        | "BabylonGenesis"
        | "BabylonTestnet5"
        | "Base"
        | "BaseGoerli"
        | "BaseSepolia"
        | "Berachain"
        | "BerachainBArtio"
        | "BerachainBepolia"
        | "Besu"
        | "Besu2"
        | "Besu3"
        | "Besu4"
        | "Besu5"
        | "Besu6"
        | "BesuTestnet"
        | "BesuTestnet2"
        | "BesuTestnet3"
        | "BesuTestnet4"
        | "BesuTestnet5"
        | "Bitcoin"
        | "BitcoinSignet"
        | "BitcoinTestnet3"
        | "BitcoinTestnet4"
        | "BitcoinCash"
        | "BitcoinCashTestnet"
        | "Bob"
        | "BobSepolia"
        | "Bsc"
        | "BscTestnet"
        | "Canton"
        | "CantonDevnet"
        | "CantonTestnet"
        | "Cardano"
        | "CardanoPreprod"
        | "Concordium"
        | "ConcordiumTestnet"
        | "Celo"
        | "CeloAlfajores"
        | "CeloSepolia"
        | "Codex"
        | "CodexSepolia"
        | "CosmosHub4"
        | "CosmosIcsTestnet"
        | "Dogecoin"
        | "DogecoinTestnet"
        | "Ethereum"
        | "EthereumClassic"
        | "EthereumClassicMordor"
        | "EthereumGoerli"
        | "EthereumSepolia"
        | "EthereumHolesky"
        | "EthereumHoodi"
        | "FantomOpera"
        | "FantomTestnet"
        | "FlareC"
        | "FlareCCoston2"
        | "FlowEvm"
        | "FlowEvmTestnet"
        | "IconTestnet"
        | "Hedera"
        | "HederaTestnet"
        | "Ink"
        | "InkSepolia"
        | "InternetComputer"
        | "Ion"
        | "IonTestnet"
        | "Iota"
        | "IotaTestnet"
        | "IotaZodianet"
        | "Kaspa"
        | "KaspaTestnet11"
        | "Kusama"
        | "KusamaAssetHub"
        | "Litecoin"
        | "LitecoinTestnet"
        | "Movement"
        | "MovementTestnet"
        | "Near"
        | "NearTestnet"
        | "Optimism"
        | "OptimismGoerli"
        | "OptimismSepolia"
        | "Origyn"
        | "Plasma"
        | "PlasmaTestnet"
        | "Plume"
        | "PlumeSepolia"
        | "Paseo"
        | "PaseoAssetHub"
        | "Polkadot"
        | "PolkadotAssetHub"
        | "Polygon"
        | "PolygonAmoy"
        | "PolygonMumbai"
        | "Polymesh"
        | "PolymeshTestnet"
        | "Race"
        | "RaceSepolia"
        | "Rayls"
        | "RaylsTestnet"
        | "Robinhood"
        | "RobinhoodSepolia"
        | "SeiAtlantic2"
        | "SeiPacific1"
        | "Solana"
        | "SolanaDevnet"
        | "Sonic"
        | "SonicTestnet"
        | "Starknet"
        | "StarknetSepolia"
        | "Stellar"
        | "StellarTestnet"
        | "Sui"
        | "SuiTestnet"
        | "Tezos"
        | "TezosGhostnet"
        | "TezosShadownet"
        | "Tempo"
        | "TempoAndantino"
        | "TempoModerato"
        | "Tsc"
        | "TscTestnet1"
        | "Ton"
        | "TonTestnet"
        | "Tron"
        | "TronNile"
        | "Westend"
        | "WestendAssetHub"
        | "Xdc"
        | "XdcApothem"
        | "XLayer"
        | "XLayerSepolia"
        | "XrpLedger"
        | "XrpLedgerTestnet";
    reason?: string;
    replacementId?: string;
    requestBody: | {
        externalId?: string;
        kind: "Transaction";
        transaction: string
        | {};
    }
    | { externalId?: string; kind: "Psbt"; psbt: string }
    | { externalId?: string; kind: "SignDocDirect"; signDoc: string }
    | {
        externalId?: string;
        feeSponsorId: string;
        kind: "UserOperations";
        userOperations: { data?: string; to: string; value?: string }[];
    }
    | { call: {}; externalId?: string; kind: "FunctionCall" }
    | { externalId?: string; kind: "TransferPreapproval" }
    | {
        data?: string;
        externalId?: string;
        gasLimit?: string | string;
        kind: "Evm";
        nonce?: number | string | string;
        to?: string;
        value?: string | string;
    }
    | {
        data?: string;
        externalId?: string;
        gasLimit?: string
        | string;
        kind: "Eip1559";
        maxFeePerGas?: string | string;
        maxPriorityFeePerGas?: string | string;
        nonce?: number | string | string;
        to?: string;
        value?: string | string;
    }
    | {
        count?: number;
        externalId?: string;
        kind: "CreateSolanaNonceAccounts";
        nonceAuthority?: string;
        priority?: "Slow"
        | "Standard"
        | "Fast";
    }
    | {
        assetCode?: string;
        assetId?: string;
        currency?: string;
        externalId?: string;
        issuer?: string;
        kind: "AcceptInboundAsset";
        tokenId?: string;
    }
    | {
        amount: string;
        destinationDomain: number;
        externalId?: string;
        feeSponsorId?: string;
        kind: "SolanaCctpBurn";
        maxFee: string;
        minFinalityThreshold: number;
        mintRecipient: string;
        usdcMint: string;
        useDurableNonce?: boolean;
    }
    | {
        decision: "Accept"
        | "Reject";
        externalId?: string;
        kind: "SettleOffer";
        txHash: string;
    }
    | { args?: {}; externalId?: string; kind: "ActivateAccount" }
    | {
        externalId?: string;
        kind: "CancelTransaction";
        signedTx: string;
        txHash?: string;
    }
    | {
        externalId?: string;
        kind: "SpeedUpTransaction";
        signedTx: string;
        txHash: string;
    };
    requester: { tokenId?: string; userId: string };
    status:
        | "Pending"
        | "Executing"
        | "Broadcasted"
        | "Confirmed"
        | "Failed"
        | "Rejected";
    txHash?: string;
    walletId: string;
}

Index

Properties

approvalId? dateBroadcasted? dateConfirmed? datePolicyResolved? dateRequested details? externalId? fee? id network reason? replacementId? requestBody requester status txHash? walletId

Properties

`Optional`approvalId

approvalId?: string

`Optional`dateBroadcasted

dateBroadcasted?: string

`Optional`dateConfirmed

dateConfirmed?: string

`Optional`datePolicyResolved

datePolicyResolved?: string

dateRequested

dateRequested: string

`Optional`details

details?: { [x: string]: unknown }

Structured representation of the data used to construct the signature (e.g. nonce, gas parameters). Shape is blockchain specific.

`Optional`externalId

externalId?: string

`Optional`fee

fee?: string

id

id: string

Transaction id.

`Optional`reason

reason?: string

`Optional`replacementId

replacementId?: string

The id of the replacement transaction (cancel or speed-up) issued for this transaction.

requestBody

requestBody:
    | { externalId?: string; kind: "Transaction"; transaction: string
    | {} }
    | { externalId?: string; kind: "Psbt"; psbt: string }
    | { externalId?: string; kind: "SignDocDirect"; signDoc: string }
    | {
        externalId?: string;
        feeSponsorId: string;
        kind: "UserOperations";
        userOperations: { data?: string; to: string; value?: string }[];
    }
    | { call: {}; externalId?: string; kind: "FunctionCall" }
    | { externalId?: string; kind: "TransferPreapproval" }
    | {
        data?: string;
        externalId?: string;
        gasLimit?: string | string;
        kind: "Evm";
        nonce?: number | string | string;
        to?: string;
        value?: string | string;
    }
    | {
        data?: string;
        externalId?: string;
        gasLimit?: string
        | string;
        kind: "Eip1559";
        maxFeePerGas?: string | string;
        maxPriorityFeePerGas?: string | string;
        nonce?: number | string | string;
        to?: string;
        value?: string | string;
    }
    | {
        count?: number;
        externalId?: string;
        kind: "CreateSolanaNonceAccounts";
        nonceAuthority?: string;
        priority?: "Slow"
        | "Standard"
        | "Fast";
    }
    | {
        assetCode?: string;
        assetId?: string;
        currency?: string;
        externalId?: string;
        issuer?: string;
        kind: "AcceptInboundAsset";
        tokenId?: string;
    }
    | {
        amount: string;
        destinationDomain: number;
        externalId?: string;
        feeSponsorId?: string;
        kind: "SolanaCctpBurn";
        maxFee: string;
        minFinalityThreshold: number;
        mintRecipient: string;
        usdcMint: string;
        useDurableNonce?: boolean;
    }
    | {
        decision: "Accept"
        | "Reject";
        externalId?: string;
        kind: "SettleOffer";
        txHash: string;
    }
    | { args?: {}; externalId?: string; kind: "ActivateAccount" }
    | {
        externalId?: string;
        kind: "CancelTransaction";
        signedTx: string;
        txHash?: string;
    }
    | {
        externalId?: string;
        kind: "SpeedUpTransaction";
        signedTx: string;
        txHash: string;
    }

Type Declaration

{ externalId?: string; kind: "Transaction"; transaction: string | {} }
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "Transaction"
- transaction: string | {}
  A JSON transaction object (recommended for EVM and other compatible networks) or an unsigned hex-encoded transaction.
{ externalId?: string; kind: "Psbt"; psbt: string }
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "Psbt"
- psbt: string
  The hex encoded PSBT.
{ externalId?: string; kind: "SignDocDirect"; signDoc: string }
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "SignDocDirect"
- signDoc: string
{
    externalId?: string;
    feeSponsorId: string;
    kind: "UserOperations";
    userOperations: { data?: string; to: string; value?: string }[];
}
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- feeSponsorId: string
  A fee sponsor id to sponsor the transaction fee by another wallet. (read more here)
- kind: "UserOperations"
- userOperations: { data?: string; to: string; value?: string }[]
{ call: {}; externalId?: string; kind: "FunctionCall" }
- call: {}
  Function call arguments
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "FunctionCall"
{ externalId?: string; kind: "TransferPreapproval" }
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "TransferPreapproval"
{
    data?: string;
    externalId?: string;
    gasLimit?: string | string;
    kind: "Evm";
    nonce?: number | string | string;
    to?: string;
    value?: string | string;
}
- Optionaldata?: string
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- OptionalgasLimit?: string | string
- kind: "Evm"
- Optionalnonce?: number | string | string
  The current nonce of the signer EOA.
- Optionalto?: string
- Optionalvalue?: string | string
{
    data?: string;
    externalId?: string;
    gasLimit?: string | string;
    kind: "Eip1559";
    maxFeePerGas?: string | string;
    maxPriorityFeePerGas?: string | string;
    nonce?: number | string | string;
    to?: string;
    value?: string | string;
}
- Optionaldata?: string
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- OptionalgasLimit?: string | string
- kind: "Eip1559"
- OptionalmaxFeePerGas?: string | string
- OptionalmaxPriorityFeePerGas?: string | string
- Optionalnonce?: number | string | string
- Optionalto?: string
- Optionalvalue?: string | string
{
    count?: number;
    externalId?: string;
    kind: "CreateSolanaNonceAccounts";
    nonceAuthority?: string;
    priority?: "Slow" | "Standard" | "Fast";
}
- Optionalcount?: number
  Optional. Number of nonce accounts to create in one bootstrap transaction (1–8; capped by Solana max-tx-size budget). Defaults to 1.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "CreateSolanaNonceAccounts"
- OptionalnonceAuthority?: string
  Optional Solana address. The wallet that will own the nonce accounts (be their on-chain authority). When omitted, the URL wallet bootstraps for itself. When set, the URL wallet pays the rent and signs the bootstrap, but the resulting accounts' authority is this address — used to bootstrap on behalf of an offline wallet that can't sign within the 90-second blockhash window.
- Optionalpriority?: "Slow" | "Standard" | "Fast"
  Priority for the bootstrap fee. Defaults to Standard.
{
    assetCode?: string;
    assetId?: string;
    currency?: string;
    externalId?: string;
    issuer?: string;
    kind: "AcceptInboundAsset";
    tokenId?: string;
}
- OptionalassetCode?: string
  Stellar asset code (1–12 ASCII alphanumeric chars).
- OptionalassetId?: string
  Algorand Standard Asset (ASA) id.
- Optionalcurrency?: string
  XRPL IOU currency code.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- Optionalissuer?: string
  Stellar (G-address) or XRPL (r-address) issuer of the asset.
- kind: "AcceptInboundAsset"
- OptionaltokenId?: string
  Hedera token entity id, e.g. "0.0.456858".
{
    amount: string;
    destinationDomain: number;
    externalId?: string;
    feeSponsorId?: string;
    kind: "SolanaCctpBurn";
    maxFee: string;
    minFinalityThreshold: number;
    mintRecipient: string;
    usdcMint: string;
    useDurableNonce?: boolean;
}
- amount: string
  USDC amount to burn (6 decimals).
- destinationDomain: number
  CCTP destination domain.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- OptionalfeeSponsorId?: string
  Fee sponsor that pays the burn network fee and the ephemeral event-account rent.
- kind: "SolanaCctpBurn"
- maxFee: string
  Max fee Circle may deduct from the burn.
- minFinalityThreshold: number
  CCTP min finality threshold (1000 Fast, 2000 Standard).
- mintRecipient: string
  Destination recipient as a bytes32 0x-hex value (EVM address left-padded).
- usdcMint: string
  Source USDC SPL mint address.
- OptionaluseDurableNonce?: boolean
  Bind the burn to a durable nonce instead of a recent blockhash.
{
    decision: "Accept" | "Reject";
    externalId?: string;
    kind: "SettleOffer";
    txHash: string;
}
- decision: "Accept" | "Reject"
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "SettleOffer"
- txHash: string
{ args?: {}; externalId?: string; kind: "ActivateAccount" }
- Optionalargs?: {}
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "ActivateAccount"
{
    externalId?: string;
    kind: "CancelTransaction";
    signedTx: string;
    txHash?: string;
}
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "CancelTransaction"
- signedTx: string
- OptionaltxHash?: string
{
    externalId?: string;
    kind: "SpeedUpTransaction";
    signedTx: string;
    txHash: string;
}
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).
- kind: "SpeedUpTransaction"
- signedTx: string
- txHash: string

requester

requester: { tokenId?: string; userId: string }

The user who initiated the request.

Type Declaration

OptionaltokenId?: string
Token id.
userId: string
User id.

status

`Optional`txHash

txHash?: string

walletId

walletId: string

Wallet id.

Type Alias CancelTransactionResponse

Index

Properties

Properties

OptionalapprovalId

OptionaldateBroadcasted

OptionaldateConfirmed

OptionaldatePolicyResolved

dateRequested

Optionaldetails

OptionalexternalId

Optionalfee

id

network

Optionalreason

OptionalreplacementId

requestBody

Type Declaration

OptionalexternalId?: string

kind: "Transaction"

transaction: string | {}

OptionalexternalId?: string

kind: "Psbt"

psbt: string

OptionalexternalId?: string

kind: "SignDocDirect"

signDoc: string

OptionalexternalId?: string

feeSponsorId: string

kind: "UserOperations"

userOperations: { data?: string; to: string; value?: string }[]

call: {}

OptionalexternalId?: string

kind: "FunctionCall"

OptionalexternalId?: string

kind: "TransferPreapproval"

Optionaldata?: string

OptionalexternalId?: string

OptionalgasLimit?: string | string

kind: "Evm"

Optionalnonce?: number | string | string

Optionalto?: string

Optionalvalue?: string | string

Optionaldata?: string

OptionalexternalId?: string

OptionalgasLimit?: string | string

kind: "Eip1559"

OptionalmaxFeePerGas?: string | string

OptionalmaxPriorityFeePerGas?: string | string

Optionalnonce?: number | string | string

Optionalto?: string

Optionalvalue?: string | string

Optionalcount?: number

OptionalexternalId?: string

kind: "CreateSolanaNonceAccounts"

OptionalnonceAuthority?: string

Optionalpriority?: "Slow" | "Standard" | "Fast"

OptionalassetCode?: string

OptionalassetId?: string

Optionalcurrency?: string

OptionalexternalId?: string

Optionalissuer?: string

kind: "AcceptInboundAsset"

OptionaltokenId?: string

amount: string

destinationDomain: number

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "SolanaCctpBurn"

maxFee: string

minFinalityThreshold: number

mintRecipient: string

usdcMint: string

OptionaluseDurableNonce?: boolean

decision: "Accept" | "Reject"

OptionalexternalId?: string

kind: "SettleOffer"

txHash: string

Optionalargs?: {}

OptionalexternalId?: string

`Optional`approvalId

`Optional`dateBroadcasted

`Optional`dateConfirmed

`Optional`datePolicyResolved

`Optional`details

`Optional`externalId

`Optional`fee

`Optional`reason

`Optional`replacementId

`Optional`externalId?: string

`Optional`externalId?: string

`Optional`externalId?: string

`Optional`externalId?: string

`Optional`externalId?: string

`Optional`externalId?: string

`Optional`data?: string

`Optional`externalId?: string

`Optional`gasLimit?: string | string

`Optional`nonce?: number | string | string

`Optional`to?: string

`Optional`value?: string | string

`Optional`data?: string

`Optional`externalId?: string

`Optional`gasLimit?: string | string

`Optional`maxFeePerGas?: string | string

`Optional`maxPriorityFeePerGas?: string | string

`Optional`nonce?: number | string | string

`Optional`to?: string

`Optional`value?: string | string

`Optional`count?: number

`Optional`externalId?: string

`Optional`nonceAuthority?: string

`Optional`priority?: "Slow" | "Standard" | "Fast"

`Optional`assetCode?: string

`Optional`assetId?: string

`Optional`currency?: string

`Optional`externalId?: string

`Optional`issuer?: string

`Optional`tokenId?: string

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`useDurableNonce?: boolean

`Optional`externalId?: string

`Optional`args?: {}

`Optional`externalId?: string

`Optional`externalId?: string

`Optional`txHash?: string

`Optional`externalId?: string

`Optional`tokenId?: string

`Optional`txHash