TransactionResponse

data class TransactionResponse(val id: String? = null, val externalTxId: String? = null, val status: Status? = null, val subStatus: String? = null, val txHash: String? = null, val operation: GetTransactionOperation? = null, val note: String? = null, val assetId: String? = null, val source: SourceTransferPeerPathResponse? = null, val sourceAddress: String? = null, val destination: DestinationTransferPeerPathResponse? = null, val destinations: List<TransactionResponseDestination>? = null, val destinationAddress: String? = null, val destinationAddressDescription: String? = null, val destinationTag: String? = null, val contractCallDecodedData: TransactionResponseContractCallDecodedData? = null, val amountInfo: AmountInfo? = null, val treatAsGrossAmount: Boolean? = null, val feeInfo: FeeInfo? = null, val feeCurrency: String? = null, val networkRecords: List<NetworkRecord>? = null, val createdAt: Long? = null, val lastUpdated: Long? = null, val createdBy: String? = null, val signedBy: List<String>? = null, val rejectedBy: String? = null, val authorizationInfo: AuthorizationInfo? = null, val exchangeTxId: String? = null, val customerRefId: String? = null, val amlScreeningResult: AmlScreeningResult? = null, val complianceResult: ComplianceResult? = null, val extraParameters: Any? = null, val signedMessages: List<SignedMessage>? = null, val numOfConfirmations: Int? = null, val blockInfo: BlockInfo? = null, val index: Int? = null, val rewardInfo: RewardInfo? = null, val systemMessages: SystemMessageInfo? = null, val addressType: AddressType? = null, val errorDescription: String? = null)

Created by Fireblocks Ltd. on 07/10/2024. Transaction response

Constructors

Link copied to clipboard
constructor(id: String? = null, externalTxId: String? = null, status: Status? = null, subStatus: String? = null, txHash: String? = null, operation: GetTransactionOperation? = null, note: String? = null, assetId: String? = null, source: SourceTransferPeerPathResponse? = null, sourceAddress: String? = null, destination: DestinationTransferPeerPathResponse? = null, destinations: List<TransactionResponseDestination>? = null, destinationAddress: String? = null, destinationAddressDescription: String? = null, destinationTag: String? = null, contractCallDecodedData: TransactionResponseContractCallDecodedData? = null, amountInfo: AmountInfo? = null, treatAsGrossAmount: Boolean? = null, feeInfo: FeeInfo? = null, feeCurrency: String? = null, networkRecords: List<NetworkRecord>? = null, createdAt: Long? = null, lastUpdated: Long? = null, createdBy: String? = null, signedBy: List<String>? = null, rejectedBy: String? = null, authorizationInfo: AuthorizationInfo? = null, exchangeTxId: String? = null, customerRefId: String? = null, amlScreeningResult: AmlScreeningResult? = null, complianceResult: ComplianceResult? = null, extraParameters: Any? = null, signedMessages: List<SignedMessage>? = null, numOfConfirmations: Int? = null, blockInfo: BlockInfo? = null, index: Int? = null, rewardInfo: RewardInfo? = null, systemMessages: SystemMessageInfo? = null, addressType: AddressType? = null, errorDescription: String? = null)

Properties

Link copied to clipboard

The type of the address. Possible values are: LEGACY, P2SH, BECH32, NATIVE_SEGWIT, P2SH_SEGWIT, UNKNOWN.

Link copied to clipboard
Link copied to clipboard
val assetId: String? = null

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.

Link copied to clipboard
Link copied to clipboard
val blockInfo: BlockInfo? = null
Link copied to clipboard
Link copied to clipboard
val createdAt: Long? = null

The transaction’s creation date and time, in unix timestamp.

Link copied to clipboard
val createdBy: String? = null

User ID of the initiator of the transaction.

Link copied to clipboard
val customerRefId: String? = null

The ID for AML providers to associate the owner of funds with transactions.

Link copied to clipboard

Destination of the transaction. see DestinationTransferPeerPathResponse. Note: In case the transaction is sent to multiple destinations, the TransactionResponse.destinations parameter is be used instead of this.

Link copied to clipboard

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.

Link copied to clipboard

Description of the address.

Link copied to clipboard

The transaction’s destinations. Note: In case the transaction is sent to a single destination, the TransactionResponse.destination parameter is used instead of this.

Link copied to clipboard
val destinationTag: String? = null

Destination address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group).

Link copied to clipboard

The transaction's revert reason. This field will be returned when subStatus = 'SMART_CONTRACT_EXECUTION_FAILED'.

Link copied to clipboard
val exchangeTxId: String? = null

If the transaction originated from an exchange, this is the ID of this transaction at the exchange.

Link copied to clipboard
val externalTxId: String? = null

Unique external transaction identifier provided by the user. Fireblocks highly recommends setting an externalTxId for every transaction created, to avoid submitting the same transaction twice.

Link copied to clipboard
val extraParameters: Any? = null

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.

Link copied to clipboard
val feeCurrency: String? = null

The asset which was withdrawn to pay the transaction fee, for example ETH for EVM-based blockchains, BTC for Tether Omni.

Link copied to clipboard
val feeInfo: FeeInfo? = null
Link copied to clipboard
val id: String? = null

Fireblocks Transaction ID

Link copied to clipboard
val index: Int? = null

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.

Link copied to clipboard
val lastUpdated: Long? = null

The transaction’s last update date and time, in unix timestamp.

Link copied to clipboard
Link copied to clipboard
val note: String? = null

Custom note, not sent to the blockchain, that describes the transaction at your Fireblocks workspace.

Link copied to clipboard
val numOfConfirmations: Int? = null

The number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy.

Link copied to clipboard

The GetTransactionOperation that was performed in the transaction.

Link copied to clipboard
val rejectedBy: String? = null

User ID of the user that rejected the transaction (in case it was rejected).

Link copied to clipboard
val rewardInfo: RewardInfo? = null

see RewardInfo. This field is relevant only for Algorand transactions. Both srcRewards and destRewards will appear only for Vault to Vault transactions, otherwise you will receive only the Fireblocks’ side of the transaction.

Link copied to clipboard
val signedBy: List<String>? = null

The list of user IDs that signed the transaction.

Link copied to clipboard
Link copied to clipboard

Source of the transaction. see SourceTransferPeerPathResponse

Link copied to clipboard
val sourceAddress: String? = null

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.

Link copied to clipboard
val status: Status? = null

The primary Status of the transaction. For details, see Primary transaction statuses

Link copied to clipboard
val subStatus: String? = null

See Transaction substatuses for the list of transaction sub statuses.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
val txHash: String? = null

The hash of the transaction on the blockchain.