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

Class GatewayResponse

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

  • Constructor Details

    • GatewayResponse

      public GatewayResponse()

  • 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()

    • getProfileProcStatus

      public String getProfileProcStatus()
      Communicates the success or failure of a Profile Management request. 0 means success, >0 is an error.

    • getProfileProcStatusMsg

      public String getProfileProcStatusMsg()
      Text message associated with getProfileProcStatus()

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

    • 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. Business logic should always use this field for its normalized representation.

    • getRespCodeMessage

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

    • getAvsRespCode

      public String getAvsRespCode()
      Response code describing the result of address verification.
      See Also:

    • getCvvRespCode

      public String getCvvRespCode()
      Response code describing the result of CVV verification.
      See Also:

    • getCustomerRefNum

      public String getCustomerRefNum()
      If the HPS submission was successful and a profile was successfully created, this is the reference number of the profile. This is important to harvest, as it's the value necessary to provide in subsequent transaction requests.

    • getCardBrand

      public String getCardBrand()
      The card brand of the card submitted by the customer.

    • getCtiCommercialCard

      public String getCtiCommercialCard()
      If "Y", the card submitted by the customer is a commercial card and supports Level 2 data.

    • 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()

    • setProfileProcStatus

      public void setProfileProcStatus(String profileProcStatus)
      Communicates the success or failure of a Profile Management request. 0 means success, >0 is an error.

    • setProfileProcStatusMsg

      public void setProfileProcStatusMsg(String profileProcStatusMsg)
      Text message associated with getProfileProcStatus()

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

    • 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. Business logic should always use this field for its normalized representation.

    • setRespCodeMessage

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

    • setAvsRespCode

      public void setAvsRespCode(String avsRespCode)
      Response code describing the result of address verification.
      See Also:

    • setCvvRespCode

      public void setCvvRespCode(String cvvRespCode)
      Response code describing the result of CVV verification.
      See Also:

    • setCustomerRefNum

      public void setCustomerRefNum(String customerRefNum)
      If the HPS submission was successful and a profile was successfully created, this is the reference number of the profile. This is important to harvest, as it's the value necessary to provide in subsequent transaction requests.

    • setCardBrand

      public void setCardBrand(String cardBrand)
      The card brand of the card submitted by the customer.

    • setCtiCommercialCard

      public void setCtiCommercialCard(String ctiCommercialCard)
      If "Y", the card submitted by the customer is a commercial card and supports Level 2 data.

    • 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