Interface CheckCreate

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableCheckCreate

@Immutable public interface CheckCreate extends Transaction
Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination. The sender of this transaction is the sender of the Check.
  • Method Details

    • builder

      static ImmutableCheckCreate.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableCheckCreate.Builder.
    • flags

      @Default default TransactionFlags flags()
      Set of TransactionFlagss for this CheckCreate, which only allows the tfFullyCanonicalSig flag, which is deprecated.

      The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.

      Returns:
      Always TransactionFlags.EMPTY.
    • destination

      Address destination()
      The unique Address of the account that can cash the Check.
      Returns:
      The unique Address of the account that can cash the Check.
    • destinationTag

      Optional<com.google.common.primitives.UnsignedInteger> destinationTag()
      Arbitrary tag that identifies the reason for the Check, or a hosted recipient to pay.
      Returns:
      An Optional of type UnsignedInteger representing the tag of the destination account.
    • sendMax

      CurrencyAmount sendMax()
      Maximum amount of source currency the Check is allowed to debit the sender, including transfer fees on non-XRP currencies. The Check can only credit the destination with the same currency (from the same issuer, for non-XRP currencies). For non-XRP amounts, the nested field names MUST be lower-case.
      Returns:
      A CurrencyAmount containing the maximum amount this check is allowed to send.
    • expiration

      Optional<com.google.common.primitives.UnsignedInteger> expiration()
      Time after which the Check is no longer valid, in seconds since the Ripple Epoch.
      Returns:
      An Optional of type UnsignedInteger denoting the expiration time.
    • invoiceId

      Optional<Hash256> invoiceId()
      Arbitrary 256-bit hash representing a specific reason or identifier for this Check.
      Returns:
      An Optional of type Hash256 containing the invoice ID.