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

Class Status

java.lang.Object
com.broadleafcommerce.vendor.chasepayment.service.support.AbstractAdditionalPropertiesAwareDTO
com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.Status
All Implemented Interfaces:
Serializable
public class Status extends AbstractAdditionalPropertiesAwareDTO implements Serializable
Subschema returned in Orbital API responses to indicate the status of an attempted transaction.
See Also:

  • Constructor Details

    • Status

      public Status()

  • Method Details

    • getProcStatus

      public String getProcStatus()

      The Orbital Gateway runs various validations on every request message, to ensure the request is valid in format and business logic. These validations happen prior to communication with the Hosts (Tandem / Stratus) and should therefore be verified first. The procStatus element is returned in all response types to communicate the result of all validations done by the Orbital Gateway.

      This is the only element that is returned in all response scenarios.

    • getProcStatusMessage

      public String getProcStatusMessage()
      Text message associated with getProcStatus()

    • getRespCode

      public String getRespCode()

      If all the Orbital-local validations pass in getProcStatus(), then the transaction will proceed to the 'Host', AKA Stratus or Tandem.

      Chase provides normalized response data from the Host in this field (for consistency between Stratus and Tandem). This will identify approval, or the reason for decline or error. Note that getHostRespCode() will contain the raw value from the host in case the consumer needs that info, but business logic should almost always use getRespCode() instead for its normalized representation.

    • getRespCodeMessage

      public String getRespCodeMessage()
      Text message associated with getRespCode().

    • getHostRespCode

      public String getHostRespCode()
      This field contains the actual, raw response code from the 'Host', AKA Stratus or Tandem. This is provided for completeness, but generally speaking any logic should target the normalized value in getRespCode() instead.

    • getApprovalStatus

      public String getApprovalStatus()

      This field is used to communicate an overall status for the transaction. The getRespCode() might have the specific error, but this field allows for a general understanding of the category of the error.

      See Also:

    • setProcStatus

      public void setProcStatus(String procStatus)

      The Orbital Gateway runs various validations on every request message, to ensure the request is valid in format and business logic. These validations happen prior to communication with the Hosts (Tandem / Stratus) and should therefore be verified first. The procStatus element is returned in all response types to communicate the result of all validations done by the Orbital Gateway.

      This is the only element that is returned in all response scenarios.

    • setProcStatusMessage

      public void setProcStatusMessage(String procStatusMessage)
      Text message associated with getProcStatus()

    • setRespCode

      public void setRespCode(String respCode)

      If all the Orbital-local validations pass in getProcStatus(), then the transaction will proceed to the 'Host', AKA Stratus or Tandem.

      Chase provides normalized response data from the Host in this field (for consistency between Stratus and Tandem). This will identify approval, or the reason for decline or error. Note that getHostRespCode() will contain the raw value from the host in case the consumer needs that info, but business logic should almost always use getRespCode() instead for its normalized representation.

    • setRespCodeMessage

      public void setRespCodeMessage(String respCodeMessage)
      Text message associated with getRespCode().

    • setHostRespCode

      public void setHostRespCode(String hostRespCode)
      This field contains the actual, raw response code from the 'Host', AKA Stratus or Tandem. This is provided for completeness, but generally speaking any logic should target the normalized value in getRespCode() instead.

    • setApprovalStatus

      public void setApprovalStatus(String approvalStatus)

      This field is used to communicate an overall status for the transaction. The getRespCode() might have the specific error, but this field allows for a general understanding of the category of the error.

      See Also:

    • 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