Class Transaction

java.lang.Object
software.xdev.brevo.model.Transaction

public class Transaction extends Object
Represents a transaction involving a balance, including status and timestamps.
  • Field Details

  • Constructor Details

    • Transaction

      public Transaction()
  • Method Details

    • amount

      public Transaction amount(@Nullable BigDecimal amount)
    • getAmount

      @Nullable public BigDecimal getAmount()
      The transaction amount.
      Returns:
      amount
    • setAmount

      public void setAmount(@Nullable BigDecimal amount)
    • balanceDefinitionId

      public Transaction balanceDefinitionId(@Nullable String balanceDefinitionId)
    • getBalanceDefinitionId

      @Nullable public String getBalanceDefinitionId()
      Unique identifier (UUID) of the associated balance definition.
      Returns:
      balanceDefinitionId
    • setBalanceDefinitionId

      public void setBalanceDefinitionId(@Nullable String balanceDefinitionId)
    • cancelledAt

      public Transaction cancelledAt(@Nullable String cancelledAt)
    • getCancelledAt

      @Nullable public String getCancelledAt()
      Timestamp when the transaction was canceled (nullable).
      Returns:
      cancelledAt
    • setCancelledAt

      public void setCancelledAt(@Nullable String cancelledAt)
    • completedAt

      public Transaction completedAt(@Nullable String completedAt)
    • getCompletedAt

      @Nullable public String getCompletedAt()
      Timestamp when the transaction was completed (nullable).
      Returns:
      completedAt
    • setCompletedAt

      public void setCompletedAt(@Nullable String completedAt)
    • contactId

      public Transaction contactId(@Nullable Integer contactId)
    • getContactId

      @Nullable public Integer getContactId()
      Unique identifier of the contact associated with the transaction.
      Returns:
      contactId
    • setContactId

      public void setContactId(@Nullable Integer contactId)
    • createdAt

      public Transaction createdAt(@Nullable String createdAt)
    • getCreatedAt

      @Nullable public String getCreatedAt()
      Timestamp when the transaction was created.
      Returns:
      createdAt
    • setCreatedAt

      public void setCreatedAt(@Nullable String createdAt)
    • eventTime

      public Transaction eventTime(@Nullable String eventTime)
    • getEventTime

      @Nullable public String getEventTime()
      Optional timestamp indicating when the transaction event occurred.
      Returns:
      eventTime
    • setEventTime

      public void setEventTime(@Nullable String eventTime)
    • expirationDate

      public Transaction expirationDate(@Nullable String expirationDate)
    • getExpirationDate

      @Nullable public String getExpirationDate()
      Expiry date of the transaction (nullable).
      Returns:
      expirationDate
    • setExpirationDate

      public void setExpirationDate(@Nullable String expirationDate)
    • id

      public Transaction id(@Nullable String id)
    • getId

      @Nullable public String getId()
      Unique identifier (UUID) of the transaction.
      Returns:
      id
    • setId

      public void setId(@Nullable String id)
    • loyaltyProgramId

      public Transaction loyaltyProgramId(@Nullable String loyaltyProgramId)
    • getLoyaltyProgramId

      @Nullable public String getLoyaltyProgramId()
      Unique identifier (UUID) of the associated loyalty program.
      Returns:
      loyaltyProgramId
    • setLoyaltyProgramId

      public void setLoyaltyProgramId(@Nullable String loyaltyProgramId)
    • meta

      public Transaction meta(@Nullable Map<String,Object> meta)
    • putMetaItem

      public Transaction putMetaItem(String key, Object metaItem)
    • getMeta

      @Nullable public Map<String,Object> getMeta()
      Optional metadata associated with the transaction.
      Returns:
      meta
    • setMeta

      public void setMeta(@Nullable Map<String,Object> meta)
    • rejectReason

      public Transaction rejectReason(@Nullable String rejectReason)
    • getRejectReason

      @Nullable public String getRejectReason()
      Reason for rejection if the transaction was declined (nullable).
      Returns:
      rejectReason
    • setRejectReason

      public void setRejectReason(@Nullable String rejectReason)
    • rejectedAt

      public Transaction rejectedAt(@Nullable String rejectedAt)
    • getRejectedAt

      @Nullable public String getRejectedAt()
      Timestamp when the transaction was rejected (nullable).
      Returns:
      rejectedAt
    • setRejectedAt

      public void setRejectedAt(@Nullable String rejectedAt)
    • status

      public Transaction status(@Nullable String status)
    • getStatus

      @Nullable public String getStatus()
      The current status of the transaction (e.g., pending, completed, rejected).
      Returns:
      status
    • setStatus

      public void setStatus(@Nullable String status)
    • updatedAt

      public Transaction updatedAt(@Nullable String updatedAt)
    • getUpdatedAt

      @Nullable public String getUpdatedAt()
      Timestamp when the transaction was last updated.
      Returns:
      updatedAt
    • setUpdatedAt

      public void setUpdatedAt(@Nullable String updatedAt)
    • equals

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

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string
    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string