Package com.broadleafcommerce.vendor.chasepayment.service.support

Class MessageConstants

java.lang.Object
com.broadleafcommerce.vendor.chasepayment.service.support.MessageConstants
public class MessageConstants extends Object
Relevant constants (ex: keys, values) for Orbital and HPS interactions.

  • Field Details

    • PAYMENT_INSTRUMENT_TYPE

      public static final String PAYMENT_INSTRUMENT_TYPE
      Key used within PaymentInfo.getPaymentMethodProperties() to indicate the payment instrument type for this payment. This is a property supplied by the API caller, which drives additional validation and semantics.
      See Also:

    • HPS_UID

      public static final String HPS_UID
      Key used within PaymentInfo.getPaymentMethodProperties() containing the UID used to submit the Chase HPS form. This is a property supplied by the API caller. This value is used by the system to obtain details and results of the customer's cardholder data submission.
      See Also:

    • ORBITAL_PROFILE_CUST_REFERENCE_NUMBER

      public static final String ORBITAL_PROFILE_CUST_REFERENCE_NUMBER
      Key used within PaymentInfo.getPaymentMethodProperties() to hold the customer reference number of the existing Orbital profile that should be used to transact. This is set by the system internally, and API-caller provided values are not honored.
      See Also:

    • CTI_COMMERCIAL_CARD_INDICATOR

      public static final String CTI_COMMERCIAL_CARD_INDICATOR
      Key used within PaymentInfo.getPaymentMethodProperties() to hold the GatewayResponse.getCtiCommercialCard() value. This is set by the system internally, and API-caller provided values are not honored.
      See Also:

    • CARD_BRAND

      public static final String CARD_BRAND
      Key used within PaymentInfo.getPaymentMethodProperties() to hold the GatewayResponse.getCardBrand() value.
      See Also:

    • PO_NUMBER

      public static final String PO_NUMBER
      Key used within PaymentInfo.getPaymentMethodProperties() to hold the generated value to pass to the LevelTwoPaymentInfo.getPCardOrderID().
      See Also:

    • PROC_STATUS

      public static final String PROC_STATUS
      Key used to hold the Status.getProcStatus() value in PaymentResponse.getResponseMap() and PaymentRequest.getAdditionalFields().
      See Also:

    • PROC_STATUS_MESSAGE

      public static final String PROC_STATUS_MESSAGE
      Key used to hold the Status.getProcStatusMessage() value in PaymentResponse.getResponseMap() and PaymentRequest.getAdditionalFields().
      See Also:

    • RESP_CODE

      public static final String RESP_CODE
      Key used to hold the Status.getRespCode() value in PaymentResponse.getResponseMap() and PaymentRequest.getAdditionalFields().
      See Also:

    • RESP_CODE_MESSAGE

      public static final String RESP_CODE_MESSAGE
      Key used to hold the Status.getRespCodeMessage() value in PaymentResponse.getResponseMap() and PaymentRequest.getAdditionalFields().
      See Also:

    • HOST_RESP_CODE

      public static final String HOST_RESP_CODE
      Key used to hold the Status.getHostRespCode() value in PaymentResponse.getResponseMap() and PaymentRequest.getAdditionalFields().
      See Also:

    • APPROVAL_STATUS

      public static final String APPROVAL_STATUS
      Key used to hold the Status.getApprovalStatus() value in PaymentResponse.getResponseMap() and PaymentRequest.getAdditionalFields().
      See Also:

    • TX_REF_NUM

      public static final String TX_REF_NUM

      When a transaction is completed, Orbital will return its own transaction reference number value for it. This is important to track, since subsequent transactions like DefaultTransactionTypes.CAPTURE or DefaultTransactionTypes.REVERSE_AUTH require access to the previous transaction reference number in order to be executed.

      This constant is the key used in PaymentResponse.getResponseMap() to hold the value of that transaction reference number. This subsequently becomes a part of PaymentTransaction.getAttributes() for that transaction, and is ultimately passed back into PaymentRequest.getAdditionalFields() for any subsequent/child transactions for use in their requests.

      This value is also tracked in PaymentResponse.getGatewayTransactionId().

      See Also:

    • TX_REF_IDX

      public static final String TX_REF_IDX

      When a transaction is completed, Orbital will return its own transaction reference number value for it and an updated Order.getTxRefIdx(). This is related to the TX_REF_NUM.

      This constant is the key used in PaymentResponse.getResponseMap() to hold the value of that transaction reference number. This subsequently becomes a part of PaymentTransaction.getAttributes() for that transaction, and is ultimately passed back into PaymentRequest.getAdditionalFields() for any subsequent/child transactions for use in their requests.

      See Also:

    • SPLIT_TX_REF_IDX

      public static final String SPLIT_TX_REF_IDX

      See Order.getSplitTxRefIdx() for more details.

      This constant is the key used in PaymentResponse.getResponseMap() to hold the value of that transaction reference number. This subsequently becomes a part of PaymentTransaction.getAttributes() for that transaction, and is ultimately passed back into PaymentRequest.getAdditionalFields() for any subsequent/child transactions for use in their requests.

      See Also:

    • RETRY_TRACE

      public static final String RETRY_TRACE

      When a transaction is completed, Orbital's response will echo the Order.getRetryTrace() that was originally provided in the request (if provided). Out of box, Broadleaf doesn't leverage Chase's retry mechanism, but if there is ever a need to retry this transaction, the request will need to contain the same retry trace number as the original attempt.

      This constant is the key used in PaymentResponse.getResponseMap() to hold the value of the retry trace number. This subsequently becomes a part of PaymentTransaction.getAttributes() for that transaction, and is ultimately passed back into PaymentRequest.getAdditionalFields() for any subsequent/child transactions for use in their requests.

      See Also:

    • APPLE_PAY_TOKEN

      public static final String APPLE_PAY_TOKEN
      Key used to hold the ApplePay token that should be used to transact.
      See Also:

    • LATITUDE_LONGITUDE

      public static final String LATITUDE_LONGITUDE
      Key used to hold the EmvInfo.getLatitudeLongitude() value. This property is required by Chase Orbital gateway payment API when using wallets with encrypted payment bundles. During creation of a payment, the geolocation of the customer should be requested and added to the paymentMethodProperties on the Payment so that it gets populated on PaymentRequest.getAdditionalFields() and can be passed to the Orbital API. If this property is not found in PaymentRequest.getAdditionalFields(), we default to the latitude/longitude location of "1,1" so that the request will still pass.
      See Also:

  • Constructor Details

    • MessageConstants

      public MessageConstants()