Sign in

v1

latestOpenAPI 3.0.02026-07-2442242189.1 KB
Transactions

InitiateTransaction

Initiate a new transaction.

post/v2/vaults/{vault_id}/transactions:initiate

Path parameters

vault_idstring required

Request body

priority'LOW' | 'NORMAL' | 'HIGH'

Generic priority enum for transactions. Translates to network specific priority values.

  • LOW: Low priority.
  • NORMAL: Normal priority. The default value.
  • HIGH: High priority.
notestring

A note to attach to the transaction.

This note will be visible to all vault members.

designatedSignersstring[]

If the transaction is designated to be signed by a specific signer, this field should be set.

Format: users/{email} or users/{id}

Example: ["users/name@example.com"] or ["users/a3e4f5"]

validateOnlyboolean

If set to true, the transaction will be validated but not created.

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

externalIdstring

A client-provided identifier for the transaction.

Must be unique per vault. Can be used to correlate the transaction with an entity in an external system.

runSimulationboolean

Run a simulation against a blockchain node to get the estimated execution results of the transaction like balance changes.

expireTimestring date-time

The expiration time of the transaction.

Example: 2025-06-10T12:30:05Z

includeReferencedResourcesboolean

Include referenced resources in the response.

Example request

{
  "details": {
    "assetTransfer": {
      "asset": "assets/native.ethereum-mainnet",
      "amount": "1.1"
    },
    "assetBatchTransfer": {
      "asset": "assets/native.ethereum-mainnet"
    },
    "evmTransaction": {
      "network": "networks/ethereum-mainnet",
      "data": "0xda82fb4c00000a"
    },
    "exchangeWithdrawal": {
      "asset": "assets/binance.USDC",
      "amount": "1.1",
      "source": "vaults/1b25635a5b3f/exchangeConnections/95257c5a522f",
      "destination": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "destinationNetwork": "networks/ethereum-mainnet"
    },
    "solanaSerializedTransaction": {
      "network": "networks/solana-mainnet"
    },
    "tronTriggerSmartContract": {
      "network": "networks/tron-mainnet",
      "data": "a9059cbb0000000000000000000000002ed5dd8a98aea00ae32517742ea5289761b2710e0000000000000000000000000000000000000000000000000000000ba43b7400"
    },
    "tronTransaction": {
      "network": "networks/tron-mainnet",
      "triggerSmartContract": {
        "data": "a9059cbb0000000000000000000000002ed5dd8a98aea00ae32517742ea5289761b2710e0000000000000000000000000000000000000000000000000000000ba43b7400"
      },
      "freezeBalanceV2": {
        "amount": "1500000"
      },
      "unfreezeBalanceV2": {
        "amount": "1500000"
      },
      "delegateResource": {
        "amount": "1500000"
      },
      "undelegateResource": {
        "amount": "1500000"
      }
    },
    "suiRawTransaction": {
      "network": "networks/ethereum-mainnet"
    },
    "xrplRawTransaction": {
      "network": "networks/xrpl-mainnet"
    },
    "stellarRawTransaction": {
      "network": "networks/stellar-mainnet"
    },
    "stellarTransaction": {
      "network": "networks/stellar-mainnet",
      "operations": [
        {
          "body": {
            "payment": {
              "asset": "USDC-GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN"
            },
            "sep41Payment": {
              "contractAddress": "CB3WFHO46J3WGRAIARNT3XD4Z7NR5SZDNG3SVKN27GOTJAQGQFAH2KAJ"
            },
            "sep41TokenApproval": {
              "contractAddress": "CB3WFHO46J3WGRAIARNT3XD4Z7NR5SZDNG3SVKN27GOTJAQGQFAH2KAJ"
            }
          }
        }
      ]
    },
    "btcTransfer": {
      "network": "networks/bitcoin-mainnet",
      "inputs": [
        {
          "txHash": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b"
        }
      ],
      "outputs": [
        {
          "amount": "0.001"
        }
      ],
      "feeSettings": {
        "feeRate": "10.5"
      }
    }
  },
  "designatedSigners": [
    "users/name@example.com"
  ],
  "requestId": "4ba6b3b1-ee91-4dcf-a4b3-e4487d7f0f46"
}

Response

A successful response.

referencedResourcesobject

A mapping of the referenced resources in the message. The key is the resource name and the value is the corresponding resource.

referencedAddressesInfoobject

A mapping of the referenced addresses in the message. The key is the address and the value is the corresponding address info.

Example response

{
  "transaction": {
    "name": "vaults/1b25635a5b3f/transactions/95257c5a522f",
    "network": "networks/ethereum-mainnet",
    "signingSession": "vaults/2d2e40r3/signingSessions/132e40r3",
    "request": {
      "name": "vaults/1b25635a5b3f/transactionRequests/95257c5a522f",
      "initiator": "users/2d2e40r3",
      "sourceWallet": "wallets/2d2e40r3"
    },
    "transfers": [
      {
        "asset": "assets/native.ethereum-mainnet"
      }
    ],
    "tokenAllowances": [
      {
        "asset": "assets/native.ethereum-mainnet"
      }
    ],
    "designatedSigners": [
      "users/name@example.com"
    ],
    "evmTransaction": {
      "data": "0xda82fb4c00000a"
    },
    "tronTransaction": {
      "freezeBalanceV2": {
        "amount": "1500000",
        "asset": "assets/native.tron-mainnet"
      },
      "unfreezeBalanceV2": {
        "amount": "1500000",
        "asset": "assets/native.tron-mainnet"
      },
      "delegateResource": {
        "amount": "1500000",
        "asset": "assets/native.tron-mainnet"
      },
      "undelegateResource": {
        "amount": "1500000",
        "asset": "assets/native.tron-mainnet"
      },
      "transferContract": {
        "amount": "1500000"
      }
    },
    "btcTransaction": {
      "inputs": [
        {
          "signingSession": "vaults/2d2e40r3/signingSessions/132e40r3"
        }
      ],
      "asset": "assets/native.bitcoin-mainnet"
    },
    "btcPsbt": {
      "inputs": [
        {
          "signingSession": "vaults/2d2e40r3/signingSessions/132e40r3"
        }
      ]
    }
  }
}