com.squareup.square.models

Class CreateCheckoutRequest

java.lang.Object

com.squareup.square.models.CreateCheckoutRequest

public class CreateCheckoutRequest
extends Object

This is a model class for CreateCheckoutRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateCheckoutRequest(String idempotencyKey, CreateOrderRequest order, Boolean askForShippingAddress, String merchantSupportEmail, String prePopulateBuyerEmail, Address prePopulateShippingAddress, String redirectUrl, List<ChargeRequestAdditionalRecipient> additionalRecipients, String note) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<ChargeRequestAdditionalRecipient>	getAdditionalRecipients() Getter for AdditionalRecipients.
Boolean	getAskForShippingAddress() Getter for AskForShippingAddress.
String	getIdempotencyKey() Getter for IdempotencyKey.
String	getMerchantSupportEmail() Getter for MerchantSupportEmail.
String	getNote() Getter for Note.
CreateOrderRequest	getOrder() Getter for Order.
String	getPrePopulateBuyerEmail() Getter for PrePopulateBuyerEmail.
Address	getPrePopulateShippingAddress() Getter for PrePopulateShippingAddress.
String	getRedirectUrl() Getter for RedirectUrl.
int	hashCode()
CreateCheckoutRequest.Builder	toBuilder() Builds a new CreateCheckoutRequest.Builder object.
String	toString() Converts this CreateCheckoutRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateCheckoutRequest

public CreateCheckoutRequest(String idempotencyKey,
                             CreateOrderRequest order,
                             Boolean askForShippingAddress,
                             String merchantSupportEmail,
                             String prePopulateBuyerEmail,
                             Address prePopulateShippingAddress,
                             String redirectUrl,
                             List<ChargeRequestAdditionalRecipient> additionalRecipients,
                             String note)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

order - CreateOrderRequest value for order.

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.

additionalRecipients - List of ChargeRequestAdditionalRecipient value for additionalRecipients.

note - String value for note.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique string that identifies this checkout among others you have created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you are unsure whether a particular checkout was created successfully, you can attempt it again with the same idempotency key and all the same other parameters without worrying about creating duplicates. You should use a random number/string generator native to the language you are working in to generate strings for your idempotency keys. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).

Returns:

Returns the String

getOrder

public CreateOrderRequest getOrder()

Getter for Order.

Returns:

Returns the CreateOrderRequest

getAskForShippingAddress

public Boolean getAskForShippingAddress()

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

Returns:

Returns the Boolean

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 seller. If this value is not set, the confirmation page and email display the primary email address associated with the seller's Square account. Default: none; only exists if explicitly set.

Returns:

Returns the String

getPrePopulateBuyerEmail

public String getPrePopulateBuyerEmail()

Getter for PrePopulateBuyerEmail. If provided, the buyer's email is prepopulated 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

getRedirectUrl

public String getRedirectUrl()

Getter for RedirectUrl. The URL to redirect to after the checkout is completed with `checkoutId`, `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: `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` If you do not provide a redirect URL, Square Checkout displays an order confirmation page on your behalf; however, it is strongly recommended that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. Default: none; only exists if explicitly set.

Returns:

Returns the String

getAdditionalRecipients

public List<ChargeRequestAdditionalRecipient> getAdditionalRecipients()

Getter for AdditionalRecipients. The basic primitive of a multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your `additional_recipients` field cannot be more than 90% of the `total_money` calculated by Square for your order. The `location_id` must be a valid seller location where the checkout is occurring. This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in the Square Sandbox.

Returns:

Returns the List of ChargeRequestAdditionalRecipient

getNote

public String getNote()

Getter for Note. An optional note to associate with the `checkout` object. This value cannot exceed 60 characters.

Returns:

Returns the String

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateCheckoutRequest.Builder toBuilder()

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

Returns:

a new CreateCheckoutRequest.Builder object