Package org.knowm.xchange.dto.account

Class FundingRecord

java.lang.Object
org.knowm.xchange.dto.account.FundingRecord
All Implemented Interfaces:
Serializable
public final class FundingRecord
extends Object
implements Serializable
DTO representing funding information

Funding information contains the detail of deposit/withdrawal transaction for a specific currency

See Also:
Serialized Form

  • Constructor Details

    • FundingRecord

      @Deprecated public FundingRecord​(String address, Date date, Currency currency, BigDecimal amount, String internalId, String blockchainTransactionHash, FundingRecord.Type type, String status, BigDecimal balance, BigDecimal fee, String description)
      Deprecated.
      Use the constructor with enum status parameter.
      Constructs a FundingRecord.
      Parameters:
      address - Crypto currency address for deposit/withdrawal
      date - Date/Time of transaction
      currency - The transaction currency
      amount - Amount deposited/withdrawn (always positive)
      internalId - Internal transaction identifier, specific to the Exchange
      blockchainTransactionHash - Transaction hash/id that identifies the transaction within the public ledger
      type - Transaction Type FundingRecord.Type
      status - Status of the transaction whenever available (e.g. Pending, Completed or any descriptive status of transaction). Will be naively converted to Status enum if possible, or else be prefixed to description.
      balance - Balance of the associated account after the transaction is performed
      fee - Transaction Fee Amount (always positive)
      description - Description of the transaction. It is a good idea to put here any extra info sent back from the exchange that doesn't fit elsewhere so users can still access it.

    • FundingRecord

      public FundingRecord​(String address, String addressTag, Date date, Currency currency, BigDecimal amount, String internalId, String blockchainTransactionHash, FundingRecord.Type type, FundingRecord.Status status, BigDecimal balance, BigDecimal fee, String description)
      Constructs a FundingRecord.
      Parameters:
      address - Crypto currency address for deposit/withdrawal
      addressTag - Crypto address destination tag for deposit/withdrawal
      date - Date/Time of transaction
      currency - The transaction currency
      amount - Amount deposited/withdrawn (always positive)
      internalId - Internal transaction identifier, specific to the Exchange
      blockchainTransactionHash - Transaction hash/id that identifies the transaction within the public ledger
      type - Transaction Type FundingRecord.Type
      status - Status of the transaction whenever available
      balance - Balance of the associated account after the transaction is performed
      fee - Transaction Fee Amount (always positive)
      description - Description of the transaction. It is a good idea to put here any extra info sent back from the exchange that doesn't fit elsewhere so users can still access it.

    • FundingRecord

      public FundingRecord​(String address, Date date, Currency currency, BigDecimal amount, String internalId, String blockchainTransactionHash, FundingRecord.Type type, FundingRecord.Status status, BigDecimal balance, BigDecimal fee, String description)
      Constructs a FundingRecord.
      Parameters:
      address - Crypto currency address for deposit/withdrawal
      date - Date/Time of transaction
      currency - The transaction currency
      amount - Amount deposited/withdrawn (always positive)
      internalId - Internal transaction identifier, specific to the Exchange
      blockchainTransactionHash - Transaction hash/id that identifies the transaction within the public ledger
      type - Transaction Type FundingRecord.Type
      status - Status of the transaction whenever available
      balance - Balance of the associated account after the transaction is performed
      fee - Transaction Fee Amount (always positive)
      description - Description of the transaction. It is a good idea to put here any extra info sent back from the exchange that doesn't fit elsewhere so users can still access it.

  • Method Details

    • getAddress

      public String getAddress()
      Returns:
      Crypto currency address

    • getAddressTag

      public String getAddressTag()

    • getDate

      public Date getDate()
      Returns:
      Date/Time of transaction

    • getCurrency

      public Currency getCurrency()
      Returns:
      The transaction currency

    • getAmount

      public BigDecimal getAmount()
      Returns:
      Amount deposited/withdrawn in given transaction currency (always positive)

    • getInternalId

      public String getInternalId()
      Returns:
      Internal transaction identifier, specific to the Exchange.

    • getExternalId

      @Deprecated public String getExternalId()
      Deprecated.

    • getBlockchainTransactionHash

      public String getBlockchainTransactionHash()
      Returns:
      External Transaction id that identifies the transaction within the public ledger, eg. blockchain transaction hash.

    • getType

      public FundingRecord.Type getType()
      Returns:
      Transaction Type FundingRecord.Type

    • getStatus

      public FundingRecord.Status getStatus()
      Returns:
      Status of the transaction whenever available (e.g. Open, Completed or any descriptive status of transaction)

    • getBalance

      public BigDecimal getBalance()
      Returns:
      Balance of the associated account after the transaction is performed

    • getFee

      public BigDecimal getFee()
      Returns:
      Transaction Fee Amount in given transaction currency (always positive)

    • getDescription

      public String getDescription()
      Returns:
      Description of the transaction

    • toString

      public String toString()
      Overrides:
      toString in class Object