Package com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas

Class Order

java.lang.Object
com.broadleafcommerce.vendor.chasepayment.service.support.AbstractAdditionalPropertiesAwareDTO
com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.Order
All Implemented Interfaces:
Serializable
public class Order extends AbstractAdditionalPropertiesAwareDTO implements Serializable
See Also:

  • Constructor Details

    • Order

      public Order()

  • Method Details

    • getOrderID

      public String getOrderID()
      The ID of the order this transaction is being executed for. This is a merchant-provided value.

    • getRetryTrace

      public String getRetryTrace()
      Merchant generated number to determine the uniqueness of a refund transaction by recognizing subsequent retries of the same request.

    • getAmount

      public String getAmount()

      Only provided in requests.

      A special-format string representing the amount of the transaction. The last two digits of this value are interpreted as the decimal. For example, to represent $1.00, the value would be "100", and to represent $123.00, the value would be "12300".

      From Chase documentation: "Note: Currency and currency code are not passed in the request. It is implied by the Currency setup for the Merchant ID."

      See Also:

    • getAdjustedAmount

      public String getAdjustedAmount()

      For OrbitalReversalRequest, this field is optionally used to specify the amount that needs to be reversed/voided. OrbitalReversalRequest uses this field instead of getAmount() to specify the amount.

      From Chase documentation:

      • When a specific amount is included with this field, that amount will be voided/reversed (assuming that the amount is not greater than the transaction amount remaining).
      • If the amount is equal to the original transaction amount then a full void/reversal is performed
      • If the amount is greater than the original amount then an error will be generated

    • getRequestAmount

      public String getRequestAmount()

      Only returned in responses.

      Echoes the amount from the request.

      See Also:

    • getRedeemedAmount

      public String getRedeemedAmount()

      Only returned in responses.

      Indicates the amount returned in the response from the host. Essentially, the actual amount transacted.

      See Also:

    • getIndustryType

      public String getIndustryType()
      The industry type for the transaction.
      See Also:

    • getStatus

      public Status getStatus()
      Only received in responses from the gateway. Not used in requests.

    • getTxRefNum

      public String getTxRefNum()

      Orbital Gateway Transaction Reference Number - a unique Orbital-generated value for each transaction.

      Can be supplied in a request (for example, when attempting to capture/reverse/refund against a previous transaction). Requests that don't need to reference a previous transaction should leave this blank (Chase docs state it will be ignored anyway).

      The Orbital gateway will return a value in this field for the value it generates for this transaction.

    • getTxRefIdx

      public String getTxRefIdx()
      Gateway Transaction Index - used to identify the unique components of transactions adjusted more than once.

    • getSplitTxRefIdx

      public String getSplitTxRefIdx()

      In partial DefaultTransactionTypes.CAPTURE transactions, Orbital will return a value in this field which is the "Transaction Reference Number of Split Transaction", or "the transaction reference number of the partial capture request". This is different from the main getTxRefNum() that would have been submitted in the original request.

      At the time of writing, this value is recorded mainly for auditing purposes, and is not leveraged anywhere for business logic.

    • setOrderID

      public void setOrderID(String orderID)
      The ID of the order this transaction is being executed for. This is a merchant-provided value.

    • setRetryTrace

      public void setRetryTrace(String retryTrace)
      Merchant generated number to determine the uniqueness of a refund transaction by recognizing subsequent retries of the same request.

    • setAmount

      public void setAmount(String amount)

      Only provided in requests.

      A special-format string representing the amount of the transaction. The last two digits of this value are interpreted as the decimal. For example, to represent $1.00, the value would be "100", and to represent $123.00, the value would be "12300".

      From Chase documentation: "Note: Currency and currency code are not passed in the request. It is implied by the Currency setup for the Merchant ID."

      See Also:

    • setAdjustedAmount

      public void setAdjustedAmount(String adjustedAmount)

      For OrbitalReversalRequest, this field is optionally used to specify the amount that needs to be reversed/voided. OrbitalReversalRequest uses this field instead of getAmount() to specify the amount.

      From Chase documentation:

      • When a specific amount is included with this field, that amount will be voided/reversed (assuming that the amount is not greater than the transaction amount remaining).
      • If the amount is equal to the original transaction amount then a full void/reversal is performed
      • If the amount is greater than the original amount then an error will be generated

    • setRequestAmount

      public void setRequestAmount(String requestAmount)

      Only returned in responses.

      Echoes the amount from the request.

      See Also:

    • setRedeemedAmount

      public void setRedeemedAmount(String redeemedAmount)

      Only returned in responses.

      Indicates the amount returned in the response from the host. Essentially, the actual amount transacted.

      See Also:

    • setIndustryType

      public void setIndustryType(String industryType)
      The industry type for the transaction.
      See Also:

    • setStatus

      public void setStatus(Status status)
      Only received in responses from the gateway. Not used in requests.

    • setTxRefNum

      public void setTxRefNum(String txRefNum)

      Orbital Gateway Transaction Reference Number - a unique Orbital-generated value for each transaction.

      Can be supplied in a request (for example, when attempting to capture/reverse/refund against a previous transaction). Requests that don't need to reference a previous transaction should leave this blank (Chase docs state it will be ignored anyway).

      The Orbital gateway will return a value in this field for the value it generates for this transaction.

    • setTxRefIdx

      public void setTxRefIdx(String txRefIdx)
      Gateway Transaction Index - used to identify the unique components of transactions adjusted more than once.

    • setSplitTxRefIdx

      public void setSplitTxRefIdx(String splitTxRefIdx)

      In partial DefaultTransactionTypes.CAPTURE transactions, Orbital will return a value in this field which is the "Transaction Reference Number of Split Transaction", or "the transaction reference number of the partial capture request". This is different from the main getTxRefNum() that would have been submitted in the original request.

      At the time of writing, this value is recorded mainly for auditing purposes, and is not leveraged anywhere for business logic.

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class AbstractAdditionalPropertiesAwareDTO

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractAdditionalPropertiesAwareDTO

    • toString

      public String toString()
      Overrides:
      toString in class AbstractAdditionalPropertiesAwareDTO