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

Class HPSOrderAbstractionInitRequest

java.lang.Object
com.broadleafcommerce.vendor.chasepayment.service.hps.domain.HPSOrderAbstractionInitRequest
All Implemented Interfaces:
Serializable
public class HPSOrderAbstractionInitRequest extends Object implements Serializable

When using Chase Hosted Payment Solutions (HPS), this is the POJO representing the actual request body sent to the Chase UID Init API.

See Also:

  • Constructor Details

    • HPSOrderAbstractionInitRequest

      public HPSOrderAbstractionInitRequest()

  • Method Details

    • getSecure_id

      public String getSecure_id()
      See Also:

    • getApi_key

      public String getApi_key()
      See Also:

    • getTxn_type

      public String getTxn_type()
      See Also:

    • getTokenize

      public String getTokenize()

      This is used to identify whether an Orbital customer profile should be created as part of an HPS submission. The only valid value (if supplied) is "1".

      Chase states that this is specifically relevant when using DefaultHPSTransactionTypes.ACCOUNT_VERIFY or any transaction type that would engage an Authorization or Authorization-Capture request.

    • getCard_indicators

      public String getCard_indicators()

      Card Indicators are authorization data elements available to merchants who use the Stratus (BIN 000001) platform. Card Indicators, also referred to as Card Type Indicators (CTI), are designed to capture valuable data that helps merchants make better payment decisions both at the time of the transaction and afterward

      When set to 'Y', card indicators will be made available to the backend in responses to subsequent UID query requests. When 'N', card indicators will not be made available. Having this information can be helpful for determining whether the customer supplied a purchasing card and thus whether Level 2 data should be included in subsequent auth/capture transactions.

    • getCustomer_ref_num

      public String getCustomer_ref_num()
      Useful if we want the Orbital profile to be created with a pre-determined ID value. The recommendation is to leave this blank to allow Chase to auto-generate the Orbital profile ID.

    • getTotal_amount

      public String getTotal_amount()
      The total amount of the transaction that should be engaged upon HPS submission, including a decimal and excluding a currency symbol. For example, "10.00". A decimal must be included to ensure the correct amount is sent. Not including a decimal may result in the incorrect amount being processed.

    • getOrder_id

      public String getOrder_id()
      System value of the order, reversal, or payment. This field is defined and supplied by us, and echoed back by Chase in responses.

    • getDescription

      public String getDescription()
      Text description of the purchase this is being submitted for.

    • getForm_name

      public String getForm_name()
      See Also:

    • getRetry_limit

      public String getRetry_limit()
      See Also:

    • getMit_msg_type

      public String getMit_msg_type()
      See Also:

    • getMerchant_data1

      public String getMerchant_data1()
      Custom field that can be used by the merchant to pass system related values.

    • getMerchant_data2

      public String getMerchant_data2()
      Custom field that can be used by the merchant to pass system related values.

    • getMerchant_data3

      public String getMerchant_data3()
      Custom field that can be used by the merchant to pass system related values.

    • getMerchant_data4

      public String getMerchant_data4()
      Custom field that can be used by the merchant to pass system related values.

    • getMerchant_data5

      public String getMerchant_data5()
      Custom field that can be used by the merchant to pass system related values.

    • getBilling_name

      public String getBilling_name()
      Customer billing address name.

    • getAddress

      public String getAddress()
      Customer street billing address first line.

    • getAddress2

      public String getAddress2()
      Customer street billing address second line.

    • getCity

      public String getCity()
      City of billing address.

    • getState_province

      public String getState_province()
      State or province of billing address

    • getPostal_code

      public String getPostal_code()
      Postal (ZIP) code of billing address

    • getCountry

      public String getCountry()
      ISO Code of country of billing address. 2 or 3 character ISO code.

    • getEmail

      public String getEmail()
      Customer email for the billing address.

    • getPhone

      public String getPhone()
      Customer phone number for the billing address.

    • setSecure_id

      public void setSecure_id(String secure_id)
      See Also:

    • setApi_key

      public void setApi_key(String api_key)
      See Also:

    • setTxn_type

      public void setTxn_type(String txn_type)
      See Also:

    • setTokenize

      public void setTokenize(String tokenize)

      This is used to identify whether an Orbital customer profile should be created as part of an HPS submission. The only valid value (if supplied) is "1".

      Chase states that this is specifically relevant when using DefaultHPSTransactionTypes.ACCOUNT_VERIFY or any transaction type that would engage an Authorization or Authorization-Capture request.

    • setCard_indicators

      public void setCard_indicators(String card_indicators)

      Card Indicators are authorization data elements available to merchants who use the Stratus (BIN 000001) platform. Card Indicators, also referred to as Card Type Indicators (CTI), are designed to capture valuable data that helps merchants make better payment decisions both at the time of the transaction and afterward

      When set to 'Y', card indicators will be made available to the backend in responses to subsequent UID query requests. When 'N', card indicators will not be made available. Having this information can be helpful for determining whether the customer supplied a purchasing card and thus whether Level 2 data should be included in subsequent auth/capture transactions.

    • setCustomer_ref_num

      public void setCustomer_ref_num(String customer_ref_num)
      Useful if we want the Orbital profile to be created with a pre-determined ID value. The recommendation is to leave this blank to allow Chase to auto-generate the Orbital profile ID.

    • setTotal_amount

      public void setTotal_amount(String total_amount)
      The total amount of the transaction that should be engaged upon HPS submission, including a decimal and excluding a currency symbol. For example, "10.00". A decimal must be included to ensure the correct amount is sent. Not including a decimal may result in the incorrect amount being processed.

    • setOrder_id

      public void setOrder_id(String order_id)
      System value of the order, reversal, or payment. This field is defined and supplied by us, and echoed back by Chase in responses.

    • setDescription

      public void setDescription(String description)
      Text description of the purchase this is being submitted for.

    • setForm_name

      public void setForm_name(String form_name)
      See Also:

    • setRetry_limit

      public void setRetry_limit(String retry_limit)
      See Also:

    • setMit_msg_type

      public void setMit_msg_type(String mit_msg_type)
      See Also:

    • setMerchant_data1

      public void setMerchant_data1(String merchant_data1)
      Custom field that can be used by the merchant to pass system related values.

    • setMerchant_data2

      public void setMerchant_data2(String merchant_data2)
      Custom field that can be used by the merchant to pass system related values.

    • setMerchant_data3

      public void setMerchant_data3(String merchant_data3)
      Custom field that can be used by the merchant to pass system related values.

    • setMerchant_data4

      public void setMerchant_data4(String merchant_data4)
      Custom field that can be used by the merchant to pass system related values.

    • setMerchant_data5

      public void setMerchant_data5(String merchant_data5)
      Custom field that can be used by the merchant to pass system related values.

    • setBilling_name

      public void setBilling_name(String billing_name)
      Customer billing address name.

    • setAddress

      public void setAddress(String address)
      Customer street billing address first line.

    • setAddress2

      public void setAddress2(String address2)
      Customer street billing address second line.

    • setCity

      public void setCity(String city)
      City of billing address.

    • setState_province

      public void setState_province(String state_province)
      State or province of billing address

    • setPostal_code

      public void setPostal_code(String postal_code)
      Postal (ZIP) code of billing address

    • setCountry

      public void setCountry(String country)
      ISO Code of country of billing address. 2 or 3 character ISO code.

    • setEmail

      public void setEmail(String email)
      Customer email for the billing address.

    • setPhone

      public void setPhone(String phone)
      Customer phone number for the billing address.

    • 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