Package com.broadleafcommerce.tabby.domain.webhook

Class TabbyWebhookEvent

java.lang.Object
com.broadleafcommerce.tabby.domain.webhook.TabbyWebhookEvent
All Implemented Interfaces:
Serializable
public class TabbyWebhookEvent extends Object implements Serializable
The webhook event. Tabby uses the Webhooks as one of the ways to notify you about any payment-related or token-related events.
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • TabbyWebhookEvent

      public TabbyWebhookEvent()

  • Method Details

    • getId

      public String getId()
      The Tabby payment ID.

    • getCreatedAt

      public String getCreatedAt()
      Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.

    • getExpiresAt

      public String getExpiresAt()
      Date and time the payment expires, in UTC, and displayed in ISO 8601 datetime format.

    • getClosedAt

      public String getClosedAt()
      Date and time the payment was closed, in UTC, and displayed in ISO 8601 datetime format.

    • getStatus

      public String getStatus()
      The status of the payment (lowercase value).
      • Authorize. Status "authorized" - It changes the status only.
      • Capture. Status "authorized" - The information about your Capture Request is added.
      • Close. Status "closed" - Such parameters as "status" and "closed_at" are changed.
      • Reject. Status "rejected" - It changes the status only.
      • Expire (Optional). Status "expired" - Such parameters as "status", "expired_at" and "is_expired" are changed.
      • Refund. Status "closed" - The information about your Refund Request is added.
      See Also:

    • isTest

      public boolean isTest()
      Indicates whether the webhook is used in the test environment or not.

    • isExpired

      public boolean isExpired()
      Indicates whether the payment is expired or not.

    • getAmount

      public String getAmount()
      The payment transaction amount.

    • getCurrency

      public String getCurrency()
      The payment transaction currency.

    • getOrder

      public TabbyOrder getOrder()
      The information about the order.

    • getCaptures

      public List<TabbyPaymentCapture> getCaptures()
      If the payment is captured, the information about it will be added to this list.

    • getRefunds

      public List<TabbyPaymentRefund> getRefunds()
      If the payment is refunded, the information about it will be added to this list.

    • setId

      public void setId(String id)
      The Tabby payment ID.

    • setCreatedAt

      public void setCreatedAt(String createdAt)
      Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.

    • setExpiresAt

      public void setExpiresAt(String expiresAt)
      Date and time the payment expires, in UTC, and displayed in ISO 8601 datetime format.

    • setClosedAt

      public void setClosedAt(String closedAt)
      Date and time the payment was closed, in UTC, and displayed in ISO 8601 datetime format.

    • setStatus

      public void setStatus(String status)
      The status of the payment (lowercase value).
      • Authorize. Status "authorized" - It changes the status only.
      • Capture. Status "authorized" - The information about your Capture Request is added.
      • Close. Status "closed" - Such parameters as "status" and "closed_at" are changed.
      • Reject. Status "rejected" - It changes the status only.
      • Expire (Optional). Status "expired" - Such parameters as "status", "expired_at" and "is_expired" are changed.
      • Refund. Status "closed" - The information about your Refund Request is added.
      See Also:

    • setTest

      public void setTest(boolean isTest)
      Indicates whether the webhook is used in the test environment or not.

    • setExpired

      public void setExpired(boolean isExpired)
      Indicates whether the payment is expired or not.

    • setAmount

      public void setAmount(String amount)
      The payment transaction amount.

    • setCurrency

      public void setCurrency(String currency)
      The payment transaction currency.

    • setOrder

      public void setOrder(TabbyOrder order)
      The information about the order.

    • setCaptures

      public void setCaptures(List<TabbyPaymentCapture> captures)
      If the payment is captured, the information about it will be added to this list.

    • setRefunds

      public void setRefunds(List<TabbyPaymentRefund> refunds)
      If the payment is refunded, the information about it will be added to this list.

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object