| Name | Type | Description | Notes |
|---|---|---|---|
| operation | TransactionOperation | [optional] [default to undefined] | |
| note | string | Custom note, not sent to the blockchain, to describe the transaction at your Fireblocks workspace. | [optional] [default to undefined] |
| externalTxId | string | This parameter will become required for all transactions on March 1, 2026. This parameter allows you to add a unique ID of your own to help prevent duplicate transactions. No specific format is required for this parameter. After you submit a transaction with an external ID, Fireblocks will automatically reject all future transactions with the same ID. Using an external ID primarily helps in situations where, even though a submitted transaction responds with an error due to an internet outage, the transaction was still sent to and processed on the blockchain. Use the Get a specific transaction by external transaction ID endpoint to validate whether these transactions have been processed. | [optional] [default to undefined] |
| assetId | string | The ID of the asset to transfer, for `TRANSFER`, `MINT` or `BURN` operations. See the list of supported assets and their IDs on Fireblocks. | [optional] [default to undefined] |
| source | SourceTransferPeerPath | [optional] [default to undefined] | |
| destination | DestinationTransferPeerPath | [optional] [default to undefined] | |
| destinations | Array<TransactionRequestDestination> | For UTXO based blockchains, you can send a single transaction to multiple destinations. | [optional] [default to undefined] |
| amount | TransactionRequestAmount | [optional] [default to undefined] | |
| treatAsGrossAmount | boolean | "When set to `true`, the fee will be deducted from the requested amount." Note: This parameter can only be considered if a transaction’s asset is a base asset, such as ETH or MATIC. If the asset can’t be used for transaction fees, like USDC, this parameter is ignored and the fee is deducted from the relevant base asset wallet in the source account. | [optional] [default to undefined] |
| forceSweep | boolean | For Polkadot, Kusama and Westend transactions only. When set to true, Fireblocks will empty the asset wallet. Note: If set to true when the source account is exactly 1 DOT, the transaction will fail. Any amount more or less than 1 DOT succeeds. This is a Polkadot blockchain limitation. | [optional] [default to undefined] |
| feeLevel | string | For UTXO or EVM-based blockchains only. Defines the blockchain fee level which will be payed for the transaction. Alternatively, specific fee estimation parameters exist below. | [optional] [default to undefined] |
| fee | TransactionRequestFee | [optional] [default to undefined] | |
| priorityFee | TransactionRequestPriorityFee | [optional] [default to undefined] | |
| failOnLowFee | boolean | When set to `true`, in case the current `MEDIUM` fee level is higher than the one specified in the transaction, the transaction will fail to avoid getting stuck with no confirmations. | [optional] [default to undefined] |
| maxFee | string | The maximum fee (gas price or fee per byte) that should be payed for the transaction. In case the current value of the requested `feeLevel` is higher than this requested maximum fee. Represented by a numeric string for accurate precision. | [optional] [default to undefined] |
| maxTotalFee | string | For BTC-based blockchains only. The maximum fee (in the units of the fee-paying asset) that should be paid for the transaction. | [optional] [default to undefined] |
| gasLimit | TransactionRequestGasLimit | [optional] [default to undefined] | |
| gasPrice | TransactionRequestGasPrice | [optional] [default to undefined] | |
| networkFee | TransactionRequestNetworkFee | [optional] [default to undefined] | |
| replaceTxByHash | string | For EVM-based blockchains only. In case a transaction is stuck, specify the hash of the stuck transaction to replace it by this transaction with a higher fee, or to replace it with this transaction with a zero fee and drop it from the blockchain. | [optional] [default to undefined] |
| extraParameters | object | Additional protocol / operation specific key-value parameters: For UTXO-based blockchain input selection, add the key `inputsSelection` with the value set the input selection structure. The inputs can be retrieved from the Retrieve Unspent Inputs endpoint. For `RAW` operations, add the key `rawMessageData` with the value set to the raw message data structure. For `CONTRACT_CALL` operations, add the key `contractCallData` with the value set to the Ethereum smart contract Application Binary Interface (ABI) payload. The Fireblocks development libraries are recommended for building contract call transactions. For exchange compliance (e.g., Binance) and Travel Rule purposes, include the key `piiData` containing a custom JSON structure with Personally Identifiable Information (PII) relevant to the transaction. This data must be fully encrypted by the sender before being submitted to the Fireblocks API. The recommended encryption method is hybrid encryption using AES-256-GCM for the payload and RSA-OAEP for key exchange, with the recipient exchange’s public key. development libraries | [optional] [default to undefined] |
| customerRefId | string | The ID for AML providers to associate the owner of funds with transactions. | [optional] [default to undefined] |
| travelRuleMessage | TravelRuleCreateTransactionRequest | [optional] [default to undefined] | |
| travelRuleMessageId | string | The ID of the travel rule message from any travel rule provider. Used for travel rule linking functionality to associate transactions with existing travel rule messages. | [optional] [default to undefined] |
| autoStaking | boolean | This feature is no longer supported. | [optional] [default to undefined] |
| networkStaking | TransactionRequestNetworkStaking | [optional] [default to undefined] | |
| cpuStaking | TransactionRequestNetworkStaking | [optional] [default to undefined] | |
| useGasless | boolean | - Override the default gasless configuration by sending true\false | [optional] [default to undefined] |
-
Low(value:'LOW') -
Medium(value:'MEDIUM') -
High(value:'HIGH')
[Back to top] [Back to API list] [Back to Model list] [Back to README]