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

Class BroadleafHPSOrderAbstractionInitRequest

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

When using Chase Hosted Payment Solutions (HPS), this is a request payload provided to the HPSOrderAbstractionEndpoint to initiate the Order Abstraction UID Init Request.

This is a BLC-specific payload, and is not directly used when interacting with Chase APIs. For that, see HPSOrderAbstractionInitRequest.

See Also:

  • Constructor Details

    • BroadleafHPSOrderAbstractionInitRequest

      public BroadleafHPSOrderAbstractionInitRequest()

  • Method Details

    • getHpsFormName

      @Nullable public String getHpsFormName()
      This field allows the API caller to request a specific, named form pre-configured in Chase HPS. If not specified, this will fall back to the HPSProviderDiscriminatedProperties.getFormName(String, String). If provided, this value is validated against HPSProviderDiscriminatedProperties.getAllowedRequestableFormNames(String, String).

    • getDescription

      @Nullable public String getDescription()
      A description that will be stored in the UID metadata (on Chase's side) to indicate why this profile was created. If not provided, a generic default value will be set by the system.

    • getPaymentOwnerType

      @Nullable public String getPaymentOwnerType()

      After HPS submission is completed and the profile is created, the caller's next step is typically to create a BLC Payment with the result. In an effort to guarantee consistency of payment ownership (i.e., a profile created for cartX cannot be used to create a Payment for cartY), the caller should send the expected payment owner information in this field. It will be passed along and stored in the UID metadata (on Chase's side).

      In most cases, this will be 'BLC_CART'.

    • getPaymentOwnerId

      @Nullable public String getPaymentOwnerId()
      In most cases, this will be the Broadleaf Cart ID. Please see getPaymentOwnerType() for more context about this field.

    • getBillingAddress

      @Nullable public BroadleafHPSOrderAbstractionInitBillingAddress getBillingAddress()
      Billing address fields. If provided, will be passed along to pre-populate the HPF with these values. Useful in scenarios where a shipping address is already known and the billing address is the 'same as shipping address'.

    • setHpsFormName

      public void setHpsFormName(@Nullable String hpsFormName)
      This field allows the API caller to request a specific, named form pre-configured in Chase HPS. If not specified, this will fall back to the HPSProviderDiscriminatedProperties.getFormName(String, String). If provided, this value is validated against HPSProviderDiscriminatedProperties.getAllowedRequestableFormNames(String, String).

    • setDescription

      public void setDescription(@Nullable String description)
      A description that will be stored in the UID metadata (on Chase's side) to indicate why this profile was created. If not provided, a generic default value will be set by the system.

    • setPaymentOwnerType

      public void setPaymentOwnerType(@Nullable String paymentOwnerType)

      After HPS submission is completed and the profile is created, the caller's next step is typically to create a BLC Payment with the result. In an effort to guarantee consistency of payment ownership (i.e., a profile created for cartX cannot be used to create a Payment for cartY), the caller should send the expected payment owner information in this field. It will be passed along and stored in the UID metadata (on Chase's side).

      In most cases, this will be 'BLC_CART'.

    • setPaymentOwnerId

      public void setPaymentOwnerId(@Nullable String paymentOwnerId)
      In most cases, this will be the Broadleaf Cart ID. Please see getPaymentOwnerType() for more context about this field.

    • setBillingAddress

      public void setBillingAddress(@Nullable BroadleafHPSOrderAbstractionInitBillingAddress billingAddress)
      Billing address fields. If provided, will be passed along to pre-populate the HPF with these values. Useful in scenarios where a shipping address is already known and the billing address is the 'same as shipping 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