com.squareup.square.models

Class CreatePaymentLinkRequest

java.lang.Object

com.squareup.square.models.CreatePaymentLinkRequest

public class CreatePaymentLinkRequest
extends Object

This is a model class for CreatePaymentLinkRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreatePaymentLinkRequest(String idempotencyKey, String description, QuickPay quickPay, Order order, CheckoutOptions checkoutOptions, PrePopulatedData prePopulatedData, String source, String paymentNote) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CheckoutOptions	getCheckoutOptions() Getter for CheckoutOptions.
String	getDescription() Getter for Description.
String	getIdempotencyKey() Getter for IdempotencyKey.
Order	getOrder() Getter for Order.
String	getPaymentNote() Getter for PaymentNote.
PrePopulatedData	getPrePopulatedData() Getter for PrePopulatedData.
QuickPay	getQuickPay() Getter for QuickPay.
String	getSource() Getter for Source.
int	hashCode()
CreatePaymentLinkRequest.Builder	toBuilder() Builds a new CreatePaymentLinkRequest.Builder object.
String	toString() Converts this CreatePaymentLinkRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreatePaymentLinkRequest

public CreatePaymentLinkRequest(String idempotencyKey,
                                String description,
                                QuickPay quickPay,
                                Order order,
                                CheckoutOptions checkoutOptions,
                                PrePopulatedData prePopulatedData,
                                String source,
                                String paymentNote)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

description - String value for description.

quickPay - QuickPay value for quickPay.

order - Order value for order.

checkoutOptions - CheckoutOptions value for checkoutOptions.

prePopulatedData - PrePopulatedData value for prePopulatedData.

source - String value for source.

paymentNote - String value for paymentNote.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique string that identifies this `CreatePaymentLinkRequest` request. If you do not provide a unique string (or provide an empty string as the value), the endpoint treats each request as independent. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. A description of the payment link. You provide this optional description that is useful in your application context. It is not used anywhere.

Returns:

Returns the String

getQuickPay

public QuickPay getQuickPay()

Getter for QuickPay. Describes an ad hoc item and price to generate a quick pay checkout link. For more information, see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout).

Returns:

Returns the QuickPay

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

getCheckoutOptions

public CheckoutOptions getCheckoutOptions()

Getter for CheckoutOptions.

Returns:

Returns the CheckoutOptions

getPrePopulatedData

public PrePopulatedData getPrePopulatedData()

Getter for PrePopulatedData. Describes buyer data to prepopulate in the payment form. For more information, see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations).

Returns:

Returns the PrePopulatedData

getSource

public String getSource()

Getter for Source. The application that created the payment link.

Returns:

Returns the String

getPaymentNote

public String getPaymentNote()

Getter for PaymentNote. A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreatePaymentLinkRequest.Builder toBuilder()

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

Returns:

a new CreatePaymentLinkRequest.Builder object