Skip to content

Latest commit

 

History

History
76 lines (67 loc) · 10.6 KB

TransactionResponse.md

File metadata and controls

76 lines (67 loc) · 10.6 KB

TransactionResponse

Properties

Name Type Description Notes
id str ID of the transaction. [optional]
external_tx_id str 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]
status str The primary status of the transaction. For details, see Primary transaction statuses. [optional]
sub_status str See Transaction substatuses for the list of transaction sub statuses. [optional]
tx_hash str 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]
operation GetTransactionOperation [optional]
note str Custom note, not sent to the blockchain, that describes the transaction at your Fireblocks workspace. [optional]
asset_id str 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]
source SourceTransferPeerPathResponse [optional]
source_address str 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]
tag str Source address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group). [optional]
destination DestinationTransferPeerPathResponse [optional]
destinations List[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]
destination_address str 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]
destination_address_description str Description of the address. [optional]
destination_tag str Destination address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group). [optional]
contract_call_decoded_data TransactionResponseContractCallDecodedData [optional]
amount_info AmountInfo [optional]
treat_as_gross_amount bool 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]
fee_info FeeInfo [optional]
fee_currency str The asset which was withdrawn to pay the transaction fee, for example ETH for EVM-based blockchains, BTC for Tether Omni. [optional]
network_records List[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]
created_at float The transaction’s creation date and time, in unix timestamp. [optional]
last_updated float The transaction’s last update date and time, in unix timestamp. [optional]
created_by str User ID of the initiator of the transaction. [optional]
signed_by List[str] User ID’s of the signers of the transaction. [optional]
rejected_by str User ID of the user that rejected the transaction (in case it was rejected). [optional]
authorization_info AuthorizationInfo [optional]
exchange_tx_id str If the transaction originated from an exchange, this is the ID of this transaction at the exchange. [optional]
customer_ref_id str The ID for AML providers to associate the owner of funds with transactions. [optional]
aml_screening_result AmlScreeningResult [optional]
compliance_result ComplianceResult [optional]
extra_parameters 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. [optional]
signed_messages List[SignedMessage] [optional]
num_of_confirmations float The number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy. [optional]
block_info BlockInfo [optional]
index float 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]
reward_info RewardInfo [optional]
system_messages SystemMessageInfo [optional]
address_type str [optional]
requested_amount float The amount requested by the user. Deprecated - please use the `amountInfo` field for accuracy. [optional]
amount float 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]
net_amount float The net amount of the transaction, after fee deduction. Deprecated - please use the `amountInfo` field for accuracy. [optional]
amount_usd float The USD value of the requested amount. Deprecated - please use the `amountInfo` field for accuracy. [optional]
service_fee float The total fee deducted by the exchange from the actual requested amount (`serviceFee` = `amount` - `netAmount`). Deprecated - please use the `feeInfo` field for accuracy. [optional]
fee float Deprecated - please use the `feeInfo` field for accuracy. [optional]
network_fee float The fee paid to the network. Deprecated - please use the `feeInfo` field for accuracy. [optional]
error_description str The transaction's revert reason. This field will be returned when `subStatus` = 'SMART_CONTRACT_EXECUTION_FAILED'. [optional]

Example

from fireblocks.models.transaction_response import TransactionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of TransactionResponse from a JSON string
transaction_response_instance = TransactionResponse.from_json(json)
# print the JSON string representation of the object
print(TransactionResponse.to_json())

# convert the object into a dict
transaction_response_dict = transaction_response_instance.to_dict()
# create an instance of TransactionResponse from a dict
transaction_response_from_dict = TransactionResponse.from_dict(transaction_response_dict)

[Back to Model list] [Back to API list] [Back to README]