Package com.stripe.model.v2.moneymanagement

Class Transaction

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.moneymanagement.Transaction
All Implemented Interfaces:
HasId, StripeObjectInterface
public class Transaction extends StripeObject implements HasId
Use Transactions to view changes to your FinancialAccount balance over time. Every flow that moves money, such as OutboundPayments or ReceivedCredits, will have one or more Transactions that describes how the flow impacted your balance. Note that while the FinancialAccount balance will always be up to date, be aware that Transactions and TransactionEntries are created shortly after to reflect changes.

  • Constructor Details

    • Transaction

      public Transaction()

  • Method Details

    • getAmount

      public Amount getAmount()
      The amount of the Transaction.

    • getBalanceImpact

      public Transaction.BalanceImpact getBalanceImpact()
      The delta to the FinancialAccount's balance. The balance_impact for the Transaction is equal to sum of its TransactionEntries that have effective_ats in the past.

    • getCategory

      public String getCategory()
      Open Enum. A descriptive category used to classify the Transaction.

      One of adjustment, currency_conversion, inbound_transfer, outbound_payment, outbound_transfer, received_credit, received_debit, return, or stripe_fee.

    • getCreated

      public Instant getCreated()
      Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • getFinancialAccount

      public String getFinancialAccount()
      Indicates the FinancialAccount affected by this Transaction.

    • getFlow

      public Transaction.Flow getFlow()
      Details about the Flow object that created the Transaction.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.money_management.transaction.

    • getStatus

      public String getStatus()
      Closed Enum. Current status of the Transaction. A Transaction is pending if either balance_impact.inbound_pending or balance_impact.outbound_pending is non-zero. A Transaction is posted if only balance_impact.available is non-zero. A Transaction is void if there is no balance impact. posted and void are terminal states, and no additional entries will be added to the Transaction.

      One of pending, posted, or void.

    • getStatusTransitions

      public Transaction.StatusTransitions getStatusTransitions()
      Timestamps for when the Transaction transitioned to a particular status.

    • setAmount

      public void setAmount(Amount amount)
      The amount of the Transaction.

    • setBalanceImpact

      public void setBalanceImpact(Transaction.BalanceImpact balanceImpact)
      The delta to the FinancialAccount's balance. The balance_impact for the Transaction is equal to sum of its TransactionEntries that have effective_ats in the past.

    • setCategory

      public void setCategory(String category)
      Open Enum. A descriptive category used to classify the Transaction.

      One of adjustment, currency_conversion, inbound_transfer, outbound_payment, outbound_transfer, received_credit, received_debit, return, or stripe_fee.

    • setCreated

      public void setCreated(Instant created)
      Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • setFinancialAccount

      public void setFinancialAccount(String financialAccount)
      Indicates the FinancialAccount affected by this Transaction.

    • setFlow

      public void setFlow(Transaction.Flow flow)
      Details about the Flow object that created the Transaction.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.money_management.transaction.

    • setStatus

      public void setStatus(String status)
      Closed Enum. Current status of the Transaction. A Transaction is pending if either balance_impact.inbound_pending or balance_impact.outbound_pending is non-zero. A Transaction is posted if only balance_impact.available is non-zero. A Transaction is void if there is no balance impact. posted and void are terminal states, and no additional entries will be added to the Transaction.

      One of pending, posted, or void.

    • setStatusTransitions

      public void setStatusTransitions(Transaction.StatusTransitions statusTransitions)
      Timestamps for when the Transaction transitioned to a particular status.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId