Package com.broadleafcommerce.tabby.domain

Class TabbyPayment

java.lang.Object
com.broadleafcommerce.tabby.domain.TabbyPayment
All Implemented Interfaces:
Serializable
public class TabbyPayment extends Object implements Serializable
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • TabbyPayment

      public TabbyPayment()

  • Method Details

    • addAttribute

      public void addAttribute(String name, Object value)
      Takes in any additional attributes passed in the request not matching any defined properties.
      Parameters:
      name - Name of the additional attribute
      value - Value of the additional attribute

    • getAttribute

      public Map<String,Object> getAttribute()
      Return any additional attributes passed in the request not matching any defined properties.
      Returns:
      any additional attributes passed in the request not matching any defined properties.

    • getId

      public String getId()
      Unique identifier for the payment (UUID), assigned by Tabby.

    • 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.

    • getStatus

      public String getStatus()
      Current status of this payment object. The payment for a new session has Created staus. A successful payment that was approved by Tabby has a status of AUTHORIZED. A payment that was successfully captured and closed has a status of CLOSED. A payment which was rejected has a status of Rejected. A payment which status wasn't updated within the session lifetime (20 minutes by default) plus payment confirmation time (up to 10 minutes) - within 30 minutes, has a status of Expired.
      See Also:

    • isTest

      public boolean isTest()
      Indicates whether this is a test payment (created using the Test API keys or Production API Keys).

    • getAmount

      public String getAmount()
      Total payment amount, including tax, shipping and any discounts. Allows to send up to 2 decimals for AED, SAR, QAR; up to 3 decimals for KWD and BHD.

    • getCurrency

      public String getCurrency()
      ISO 4217 currency code for the payment amount. Default: "AED".

      Enum: "AED" "SAR" "KWD" "BHD" "QAR"

    • getDescription

      public String getDescription()

    • getBuyer

      public TabbyBuyer getBuyer()

    • getShippingAddress

      public TabbyShippingAddress getShippingAddress()

    • getOrder

      public TabbyOrder getOrder()

    • getCaptures

      public List<TabbyPaymentCapture> getCaptures()

    • getRefunds

      public List<TabbyPaymentRefund> getRefunds()

    • getBuyerHistory

      public TabbyBuyerHistory getBuyerHistory()

    • getOrderHistory

      public List<TabbyOrderHistory> getOrderHistory()

    • getMeta

      public Map<String,Object> getMeta()
      Merchant-defined data about the payment. This field is a key-value map.

    • getAttachment

      public TabbyAttachment getAttachment()
      Extra data (booking info, insurance, flight reservations, ...) as serialized JSON

    • getAttributes

      public Map<String,Object> getAttributes()
      Map holding any additional attributes passed in the request not matching any defined properties.

    • setId

      public void setId(String id)
      Unique identifier for the payment (UUID), assigned by Tabby.

    • 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.

    • setStatus

      public void setStatus(String status)
      Current status of this payment object. The payment for a new session has Created staus. A successful payment that was approved by Tabby has a status of AUTHORIZED. A payment that was successfully captured and closed has a status of CLOSED. A payment which was rejected has a status of Rejected. A payment which status wasn't updated within the session lifetime (20 minutes by default) plus payment confirmation time (up to 10 minutes) - within 30 minutes, has a status of Expired.
      See Also:

    • setTest

      public void setTest(boolean isTest)
      Indicates whether this is a test payment (created using the Test API keys or Production API Keys).

    • setAmount

      public void setAmount(String amount)
      Total payment amount, including tax, shipping and any discounts. Allows to send up to 2 decimals for AED, SAR, QAR; up to 3 decimals for KWD and BHD.

    • setCurrency

      public void setCurrency(String currency)
      ISO 4217 currency code for the payment amount. Default: "AED".

      Enum: "AED" "SAR" "KWD" "BHD" "QAR"

    • setDescription

      public void setDescription(String description)

    • setBuyer

      public void setBuyer(TabbyBuyer buyer)

    • setShippingAddress

      public void setShippingAddress(TabbyShippingAddress shippingAddress)

    • setOrder

      public void setOrder(TabbyOrder order)

    • setCaptures

      public void setCaptures(List<TabbyPaymentCapture> captures)

    • setRefunds

      public void setRefunds(List<TabbyPaymentRefund> refunds)

    • setBuyerHistory

      public void setBuyerHistory(TabbyBuyerHistory buyerHistory)

    • setOrderHistory

      public void setOrderHistory(List<TabbyOrderHistory> orderHistory)

    • setMeta

      public void setMeta(Map<String,Object> meta)
      Merchant-defined data about the payment. This field is a key-value map.

    • setAttachment

      public void setAttachment(TabbyAttachment attachment)
      Extra data (booking info, insurance, flight reservations, ...) as serialized JSON

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Map holding any additional attributes passed in the request not matching any defined properties.

    • 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