| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the transaction. | [optional] [default to undefined] |
| externalTxId | string | Unique transaction ID provided by the user. Fireblocks highly recommends setting an `externalTxId` for every transaction created, to avoid submitting the same transaction twice. | [optional] [default to undefined] |
| status | string | The primary status of the transaction. For details, see Primary transaction statuses. | [optional] [default to undefined] |
| subStatus | string | See Transaction substatuses for the list of transaction sub statuses. | [optional] [default to undefined] |
| txHash | string | The hash of the transaction on the blockchain. * This parameter exists if at least one of the following conditions is met: 1. The transaction’s source type is `UNKNOWN`, `WHITELISTED_ADDRESS`, `NETWORK_CONNECTION`, `ONE_TIME_ADDRESS`, `FIAT_ACCOUNT` or `GAS_STATION`. 2. The transaction’s source type is `VAULT` and the status is either: `CONFIRMING`, `COMPLETED`, or was in any of these statuses prior to changing to `FAILED` or `REJECTED`. In some instances, transactions in status `BROADCASTING` will include the txHash as well. 3. The transaction’s source type is `EXCHANGE_ACCOUNT` and the transaction’s destination type is `VAULT`, and the status is either: `CONFIRMING`, `COMPLETED`, or was in any of these status prior to changing to `FAILED`. * In addition, the following conditions must be met: 1. The asset is a crypto asset (not fiat). 2. The transaction operation is not RAW or `TYPED_MESSAGE`. | [optional] [default to undefined] |
| operation | GetTransactionOperation | [optional] [default to undefined] | |
| note | string | Custom note, not sent to the blockchain, that describes the transaction at your Fireblocks workspace. | [optional] [default to undefined] |
| assetId | string | The ID of the asset to transfer, for `TRANSFER`, `MINT`, `BURN`, `ENABLE_ASSET`,`STAKE` ,`UNSTAKE` or `WITHDRAW` operations. See the list of supported assets and their IDs on Fireblocks. | [optional] [default to undefined] |
| assetType | string | Type classification of the asset | [optional] [default to undefined] |
| source | SourceTransferPeerPathResponse | [optional] [default to undefined] | |
| sourceAddress | string | For account based assets only, the source address of the transaction. Note: If the status is `CONFIRMING`, `COMPLETED`, or has been `CONFIRMING`; then moved forward to `FAILED` or `REJECTED`, then this parameter will contain the source address. In any other case, this parameter will be empty. | [optional] [default to undefined] |
| tag | string | Source address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group). | [optional] [default to undefined] |
| destination | DestinationTransferPeerPathResponse | [optional] [default to undefined] | |
| destinations | Array<TransactionResponseDestination> | The transaction’s destinations. Note: In case the transaction is sent to a single destination, the `destination` parameter is used instead of this. | [optional] [default to undefined] |
| destinationAddress | string | Address where the asset were transferred. Notes: - For Multi destination transactions, this parameter will be empty. In this case, you should refer to the destinations field. - If the status is `CONFIRMING`, `COMPLETED`, or has been `CONFIRMING`; then moved forward to `FAILED` or `REJECTED`, then this parameter will contain the destination address. In any other case, this parameter will be empty. | [optional] [default to undefined] |
| destinationAddressDescription | string | Description of the address. | [optional] [default to undefined] |
| destinationTag | string | Destination address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group). | [optional] [default to undefined] |
| contractCallDecodedData | TransactionResponseContractCallDecodedData | [optional] [default to undefined] | |
| amountInfo | AmountInfo | [optional] [default to undefined] | |
| treatAsGrossAmount | boolean | For transactions initiated via this Fireblocks workspace, when set to `true`, the fee is 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] |
| feeInfo | FeeInfo | [optional] [default to undefined] | |
| feeCurrency | string | The asset which was withdrawn to pay the transaction fee, for example ETH for EVM-based blockchains, BTC for Tether Omni. | [optional] [default to undefined] |
| networkRecords | Array<NetworkRecord> | In case a single transaction resulted with multiple transfers, for example a result of a contract call, then this parameter specifies each transfer that took place on the blockchain. In case of a single transfer transaction, this parameter is empty. | [optional] [default to undefined] |
| createdAt | number | The transaction’s creation date and time, in unix timestamp. | [optional] [default to undefined] |
| lastUpdated | number | The transaction’s last update date and time, in unix timestamp. | [optional] [default to undefined] |
| createdBy | string | User ID of the initiator of the transaction. | [optional] [default to undefined] |
| signedBy | Array<string> | User ID’s of the signers of the transaction. | [optional] [default to undefined] |
| rejectedBy | string | User ID of the user that rejected the transaction (in case it was rejected). | [optional] [default to undefined] |
| authorizationInfo | AuthorizationInfo | [optional] [default to undefined] | |
| exchangeTxId | string | If the transaction originated from an exchange, this is the ID of this transaction at the exchange. | [optional] [default to undefined] |
| customerRefId | string | The ID for AML providers to associate the owner of funds with transactions. | [optional] [default to undefined] |
| amlScreeningResult | AmlScreeningResult | [optional] [default to undefined] | |
| complianceResults | ComplianceResults | [optional] [default to undefined] | |
| notBroadcastByFireblocks | boolean | Indicates the transaction was not broadcast by Fireblocks | [optional] [default to undefined] |
| dappUrl | string | DApp URL for Web3 transactions | [optional] [default to undefined] |
| gasLimit | string | Gas limit for EVM-based blockchain transactions | [optional] [default to undefined] |
| blockchainIndex | string | Blockchain-specific index or identifier for the transaction | [optional] [default to undefined] |
| paidRent | string | Solana rent payment amount | [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] |
| signedMessages | SignedMessages | [optional] [default to undefined] | |
| numOfConfirmations | number | The number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy. | [optional] [default to undefined] |
| blockInfo | BlockInfo | [optional] [default to undefined] | |
| index | number | For UTXO based assets this is the vOut, for Ethereum based, this is the index of the event of the contract call. Note: This field is not returned if a transaction uses the `destinations` object with more than one value. | [optional] [default to undefined] |
| rewardInfo | RewardInfo | [optional] [default to undefined] | |
| feePayerInfo | FeePayerInfo | [optional] [default to undefined] | |
| systemMessages | SystemMessageInfo | [optional] [default to undefined] | |
| addressType | string | [optional] [default to undefined] | |
| requestedAmount | number | The amount requested by the user. Deprecated - please use the `amountInfo` field for accuracy. | [optional] [default to undefined] |
| amount | number | If the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, the requested amount. Deprecated - please use the `amountInfo` field for accuracy. | [optional] [default to undefined] |
| netAmount | number | The net amount of the transaction, after fee deduction. Deprecated - please use the `amountInfo` field for accuracy. | [optional] [default to undefined] |
| amountUSD | number | The USD value of the requested amount. Deprecated - please use the `amountInfo` field for accuracy. | [optional] [default to undefined] |
| serviceFee | number | The total fee deducted by the exchange from the actual requested amount (`serviceFee` = `amount` - `netAmount`). Deprecated - please use the `feeInfo` field for accuracy. | [optional] [default to undefined] |
| fee | number | Deprecated - please use the `feeInfo` field for accuracy. | [optional] [default to undefined] |
| networkFee | number | The fee paid to the network. Deprecated - please use the `feeInfo` field for accuracy. | [optional] [default to undefined] |
| errorDescription | string | The transaction's revert reason. This field will be returned when `subStatus` = 'SMART_CONTRACT_EXECUTION_FAILED'. | [optional] [default to undefined] |
| replacedTxHash | string | if the transaction is a replace by fee (RBF) transaction, this is the hash of the transsaction that was replaced | [optional] [default to undefined] |
| nonce | string | blockchain nonce for the transaction | [optional] [default to undefined] |
| blockchainInfo | object | A JSON used to store additional data that is blockchain-specific. | [optional] [default to undefined] |
-
Empty(value:'') -
Whitelisted(value:'WHITELISTED') -
OneTime(value:'ONE_TIME')
[Back to top] [Back to API list] [Back to Model list] [Back to README]