com.squareup.square.models

Class Checkout

java.lang.Object

com.squareup.square.models.Checkout

public class Checkout
extends Object

This is a model class for Checkout type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Checkout(String id, io.apimatic.core.types.OptionalNullable<String> checkoutPageUrl, io.apimatic.core.types.OptionalNullable<Boolean> askForShippingAddress, io.apimatic.core.types.OptionalNullable<String> merchantSupportEmail, io.apimatic.core.types.OptionalNullable<String> prePopulateBuyerEmail, Address prePopulateShippingAddress, io.apimatic.core.types.OptionalNullable<String> redirectUrl, Order order, String createdAt, io.apimatic.core.types.OptionalNullable<List<AdditionalRecipient>> additionalRecipients) Internal initialization constructor.
	Checkout(String id, String checkoutPageUrl, Boolean askForShippingAddress, String merchantSupportEmail, String prePopulateBuyerEmail, Address prePopulateShippingAddress, String redirectUrl, Order order, String createdAt, List<AdditionalRecipient> additionalRecipients) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<AdditionalRecipient>	getAdditionalRecipients() Getter for AdditionalRecipients.
Boolean	getAskForShippingAddress() Getter for AskForShippingAddress.
String	getCheckoutPageUrl() Getter for CheckoutPageUrl.
String	getCreatedAt() Getter for CreatedAt.
String	getId() Getter for Id.
String	getMerchantSupportEmail() Getter for MerchantSupportEmail.
Order	getOrder() Getter for Order.
String	getPrePopulateBuyerEmail() Getter for PrePopulateBuyerEmail.
Address	getPrePopulateShippingAddress() Getter for PrePopulateShippingAddress.
String	getRedirectUrl() Getter for RedirectUrl.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<AdditionalRecipient>>	internalGetAdditionalRecipients() Internal Getter for AdditionalRecipients.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAskForShippingAddress() Internal Getter for AskForShippingAddress.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCheckoutPageUrl() Internal Getter for CheckoutPageUrl.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetMerchantSupportEmail() Internal Getter for MerchantSupportEmail.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPrePopulateBuyerEmail() Internal Getter for PrePopulateBuyerEmail.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetRedirectUrl() Internal Getter for RedirectUrl.
Checkout.Builder	toBuilder() Builds a new Checkout.Builder object.
String	toString() Converts this Checkout into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Checkout

public Checkout(String id,
                String checkoutPageUrl,
                Boolean askForShippingAddress,
                String merchantSupportEmail,
                String prePopulateBuyerEmail,
                Address prePopulateShippingAddress,
                String redirectUrl,
                Order order,
                String createdAt,
                List<AdditionalRecipient> additionalRecipients)

Initialization constructor.

Parameters:

id - String value for id.

checkoutPageUrl - String value for checkoutPageUrl.

askForShippingAddress - Boolean value for askForShippingAddress.

merchantSupportEmail - String value for merchantSupportEmail.

prePopulateBuyerEmail - String value for prePopulateBuyerEmail.

prePopulateShippingAddress - Address value for prePopulateShippingAddress.

redirectUrl - String value for redirectUrl.

order - Order value for order.

createdAt - String value for createdAt.

additionalRecipients - List of AdditionalRecipient value for additionalRecipients.

Checkout

protected Checkout(String id,
                   io.apimatic.core.types.OptionalNullable<String> checkoutPageUrl,
                   io.apimatic.core.types.OptionalNullable<Boolean> askForShippingAddress,
                   io.apimatic.core.types.OptionalNullable<String> merchantSupportEmail,
                   io.apimatic.core.types.OptionalNullable<String> prePopulateBuyerEmail,
                   Address prePopulateShippingAddress,
                   io.apimatic.core.types.OptionalNullable<String> redirectUrl,
                   Order order,
                   String createdAt,
                   io.apimatic.core.types.OptionalNullable<List<AdditionalRecipient>> additionalRecipients)

Internal initialization constructor.

Method Detail

getId

public String getId()

Getter for Id. ID generated by Square Checkout when a new checkout is requested.

Returns:

Returns the String

internalGetCheckoutPageUrl

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

Internal Getter for CheckoutPageUrl. The URL that the buyer's browser should be redirected to after the checkout is completed.

Returns:

Returns the Internal String

getCheckoutPageUrl

public String getCheckoutPageUrl()

Getter for CheckoutPageUrl. The URL that the buyer's browser should be redirected to after the checkout is completed.

Returns:

Returns the String

internalGetAskForShippingAddress

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

Internal Getter for AskForShippingAddress. If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`.

Returns:

Returns the Internal Boolean

getAskForShippingAddress

public Boolean getAskForShippingAddress()

Getter for AskForShippingAddress. If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`.

Returns:

Returns the Boolean

internalGetMerchantSupportEmail

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

Internal Getter for MerchantSupportEmail. The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set.

Returns:

Returns the Internal String

getMerchantSupportEmail

public String getMerchantSupportEmail()

Getter for MerchantSupportEmail. The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set.

Returns:

Returns the String

internalGetPrePopulateBuyerEmail

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

Internal Getter for PrePopulateBuyerEmail. If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set.

Returns:

Returns the Internal String

getPrePopulateBuyerEmail

public String getPrePopulateBuyerEmail()

Getter for PrePopulateBuyerEmail. If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set.

Returns:

Returns the String

getPrePopulateShippingAddress

public Address getPrePopulateShippingAddress()

Getter for PrePopulateShippingAddress. Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the Address

internalGetRedirectUrl

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

Internal Getter for RedirectUrl. The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to: <pre><code>http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx</code></pre> If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.

Returns:

Returns the Internal String

getRedirectUrl

public String getRedirectUrl()

Getter for RedirectUrl. The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to: <pre><code>http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx</code></pre> If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.

Returns:

Returns the String

getOrder

public Order getOrder()

Getter for Order. Contains all information related to a single order to process with Square, including line items that specify the products to purchase. `Order` objects also include information about any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data.

Returns:

Returns the Order

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The time when the checkout was created, in RFC 3339 format.

Returns:

Returns the String

internalGetAdditionalRecipients

protected io.apimatic.core.types.OptionalNullable<List<AdditionalRecipient>> internalGetAdditionalRecipients()

Internal Getter for AdditionalRecipients. Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration.

Returns:

Returns the Internal List of AdditionalRecipient

getAdditionalRecipients

public List<AdditionalRecipient> getAdditionalRecipients()

Getter for AdditionalRecipients. Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration.

Returns:

Returns the List of AdditionalRecipient

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 Checkout into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Checkout.Builder toBuilder()

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

Returns:

a new Checkout.Builder object