com.squareup.square.models

Class CheckoutOptions

java.lang.Object

com.squareup.square.models.CheckoutOptions

public class CheckoutOptions
extends Object

This is a model class for CheckoutOptions type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckoutOptions.Builder Class to build instances of CheckoutOptions.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CheckoutOptions(Boolean allowTipping, List<CustomField> customFields, String subscriptionPlanId, String redirectUrl, String merchantSupportEmail, Boolean askForShippingAddress, AcceptedPaymentMethods acceptedPaymentMethods, Money appFeeMoney, ShippingFee shippingFee, Boolean enableCoupon, Boolean enableLoyalty) Initialization constructor.
protected	CheckoutOptions(io.apimatic.core.types.OptionalNullable<Boolean> allowTipping, io.apimatic.core.types.OptionalNullable<List<CustomField>> customFields, io.apimatic.core.types.OptionalNullable<String> subscriptionPlanId, io.apimatic.core.types.OptionalNullable<String> redirectUrl, io.apimatic.core.types.OptionalNullable<String> merchantSupportEmail, io.apimatic.core.types.OptionalNullable<Boolean> askForShippingAddress, AcceptedPaymentMethods acceptedPaymentMethods, Money appFeeMoney, ShippingFee shippingFee, io.apimatic.core.types.OptionalNullable<Boolean> enableCoupon, io.apimatic.core.types.OptionalNullable<Boolean> enableLoyalty) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AcceptedPaymentMethods	getAcceptedPaymentMethods() Getter for AcceptedPaymentMethods.
Boolean	getAllowTipping() Getter for AllowTipping.
Money	getAppFeeMoney() Getter for AppFeeMoney.
Boolean	getAskForShippingAddress() Getter for AskForShippingAddress.
List<CustomField>	getCustomFields() Getter for CustomFields.
Boolean	getEnableCoupon() Getter for EnableCoupon.
Boolean	getEnableLoyalty() Getter for EnableLoyalty.
String	getMerchantSupportEmail() Getter for MerchantSupportEmail.
String	getRedirectUrl() Getter for RedirectUrl.
ShippingFee	getShippingFee() Getter for ShippingFee.
String	getSubscriptionPlanId() Getter for SubscriptionPlanId.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAllowTipping() Internal Getter for AllowTipping.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAskForShippingAddress() Internal Getter for AskForShippingAddress.
protected io.apimatic.core.types.OptionalNullable<List<CustomField>>	internalGetCustomFields() Internal Getter for CustomFields.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetEnableCoupon() Internal Getter for EnableCoupon.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetEnableLoyalty() Internal Getter for EnableLoyalty.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetMerchantSupportEmail() Internal Getter for MerchantSupportEmail.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetRedirectUrl() Internal Getter for RedirectUrl.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSubscriptionPlanId() Internal Getter for SubscriptionPlanId.
CheckoutOptions.Builder	toBuilder() Builds a new CheckoutOptions.Builder object.
String	toString() Converts this CheckoutOptions into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CheckoutOptions

public CheckoutOptions(Boolean allowTipping,
                       List<CustomField> customFields,
                       String subscriptionPlanId,
                       String redirectUrl,
                       String merchantSupportEmail,
                       Boolean askForShippingAddress,
                       AcceptedPaymentMethods acceptedPaymentMethods,
                       Money appFeeMoney,
                       ShippingFee shippingFee,
                       Boolean enableCoupon,
                       Boolean enableLoyalty)

Initialization constructor.

Parameters:

allowTipping - Boolean value for allowTipping.

customFields - List of CustomField value for customFields.

subscriptionPlanId - String value for subscriptionPlanId.

redirectUrl - String value for redirectUrl.

merchantSupportEmail - String value for merchantSupportEmail.

askForShippingAddress - Boolean value for askForShippingAddress.

acceptedPaymentMethods - AcceptedPaymentMethods value for acceptedPaymentMethods.

appFeeMoney - Money value for appFeeMoney.

shippingFee - ShippingFee value for shippingFee.

enableCoupon - Boolean value for enableCoupon.

enableLoyalty - Boolean value for enableLoyalty.

CheckoutOptions

protected CheckoutOptions(io.apimatic.core.types.OptionalNullable<Boolean> allowTipping,
                          io.apimatic.core.types.OptionalNullable<List<CustomField>> customFields,
                          io.apimatic.core.types.OptionalNullable<String> subscriptionPlanId,
                          io.apimatic.core.types.OptionalNullable<String> redirectUrl,
                          io.apimatic.core.types.OptionalNullable<String> merchantSupportEmail,
                          io.apimatic.core.types.OptionalNullable<Boolean> askForShippingAddress,
                          AcceptedPaymentMethods acceptedPaymentMethods,
                          Money appFeeMoney,
                          ShippingFee shippingFee,
                          io.apimatic.core.types.OptionalNullable<Boolean> enableCoupon,
                          io.apimatic.core.types.OptionalNullable<Boolean> enableLoyalty)

Internal initialization constructor.

Method Detail

internalGetAllowTipping

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAllowTipping()

Internal Getter for AllowTipping. Indicates whether the payment allows tipping.

Returns:

Returns the Internal Boolean

getAllowTipping

public Boolean getAllowTipping()

Getter for AllowTipping. Indicates whether the payment allows tipping.

Returns:

Returns the Boolean

internalGetCustomFields

protected io.apimatic.core.types.OptionalNullable<List<CustomField>> internalGetCustomFields()

Internal Getter for CustomFields. The custom fields requesting information from the buyer.

Returns:

Returns the Internal List of CustomField

getCustomFields

public List<CustomField> getCustomFields()

Getter for CustomFields. The custom fields requesting information from the buyer.

Returns:

Returns the List of CustomField

internalGetSubscriptionPlanId

protected io.apimatic.core.types.OptionalNullable<String> internalGetSubscriptionPlanId()

Internal Getter for SubscriptionPlanId. The ID of the subscription plan for the buyer to pay and subscribe. For more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout).

Returns:

Returns the Internal String

getSubscriptionPlanId

public String getSubscriptionPlanId()

Getter for SubscriptionPlanId. The ID of the subscription plan for the buyer to pay and subscribe. For more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout).

Returns:

Returns the String

internalGetRedirectUrl

protected io.apimatic.core.types.OptionalNullable<String> internalGetRedirectUrl()

Internal Getter for RedirectUrl. The confirmation page URL to redirect the buyer to after Square processes the payment.

Returns:

Returns the Internal String

getRedirectUrl

public String getRedirectUrl()

Getter for RedirectUrl. The confirmation page URL to redirect the buyer to after Square processes the payment.

Returns:

Returns the String

internalGetMerchantSupportEmail

protected io.apimatic.core.types.OptionalNullable<String> internalGetMerchantSupportEmail()

Internal Getter for MerchantSupportEmail. The email address that buyers can use to contact the seller.

Returns:

Returns the Internal String

getMerchantSupportEmail

public String getMerchantSupportEmail()

Getter for MerchantSupportEmail. The email address that buyers can use to contact the seller.

Returns:

Returns the String

internalGetAskForShippingAddress

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAskForShippingAddress()

Internal Getter for AskForShippingAddress. Indicates whether to include the address fields in the payment form.

Returns:

Returns the Internal Boolean

getAskForShippingAddress

public Boolean getAskForShippingAddress()

Getter for AskForShippingAddress. Indicates whether to include the address fields in the payment form.

Returns:

Returns the Boolean

getAcceptedPaymentMethods

public AcceptedPaymentMethods getAcceptedPaymentMethods()

Getter for AcceptedPaymentMethods.

Returns:

Returns the AcceptedPaymentMethods

getAppFeeMoney

public Money getAppFeeMoney()

Getter for AppFeeMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getShippingFee

public ShippingFee getShippingFee()

Getter for ShippingFee.

Returns:

Returns the ShippingFee

internalGetEnableCoupon

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetEnableCoupon()

Internal Getter for EnableCoupon. Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form.

Returns:

Returns the Internal Boolean

getEnableCoupon

public Boolean getEnableCoupon()

Getter for EnableCoupon. Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form.

Returns:

Returns the Boolean

internalGetEnableLoyalty

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetEnableLoyalty()

Internal Getter for EnableLoyalty. Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.

Returns:

Returns the Internal Boolean

getEnableLoyalty

public Boolean getEnableLoyalty()

Getter for EnableLoyalty. Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.

Returns:

Returns the Boolean

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CheckoutOptions into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CheckoutOptions.Builder toBuilder()

Builds a new CheckoutOptions.Builder object. Creates the instance with the state of the current model.

Returns:

a new CheckoutOptions.Builder object