com.squareup.square.models

Class PaymentLink

java.lang.Object

com.squareup.square.models.PaymentLink

public class PaymentLink
extends Object

This is a model class for PaymentLink type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PaymentLink(int version, String id, String description, String orderId, CheckoutOptions checkoutOptions, PrePopulatedData prePopulatedData, String url, String createdAt, String updatedAt, String paymentNote) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CheckoutOptions	getCheckoutOptions() Getter for CheckoutOptions.
String	getCreatedAt() Getter for CreatedAt.
String	getDescription() Getter for Description.
String	getId() Getter for Id.
String	getOrderId() Getter for OrderId.
String	getPaymentNote() Getter for PaymentNote.
PrePopulatedData	getPrePopulatedData() Getter for PrePopulatedData.
String	getUpdatedAt() Getter for UpdatedAt.
String	getUrl() Getter for Url.
int	getVersion() Getter for Version.
int	hashCode()
PaymentLink.Builder	toBuilder() Builds a new PaymentLink.Builder object.
String	toString() Converts this PaymentLink into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentLink

public PaymentLink(int version,
                   String id,
                   String description,
                   String orderId,
                   CheckoutOptions checkoutOptions,
                   PrePopulatedData prePopulatedData,
                   String url,
                   String createdAt,
                   String updatedAt,
                   String paymentNote)

Initialization constructor.

Parameters:

version - int value for version.

id - String value for id.

description - String value for description.

orderId - String value for orderId.

checkoutOptions - CheckoutOptions value for checkoutOptions.

prePopulatedData - PrePopulatedData value for prePopulatedData.

url - String value for url.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

paymentNote - String value for paymentNote.

Method Detail

getId

public String getId()

Getter for Id. The Square-assigned ID of the payment link.

Returns:

Returns the String

getVersion

public int getVersion()

Getter for Version. The Square-assigned version number, which is incremented each time an update is committed to the payment link.

Returns:

Returns the int

getDescription

public String getDescription()

Getter for Description. The optional description of the `payment_link` object. It is primarily for use by your application and is not used anywhere.

Returns:

Returns the String

getOrderId

public String getOrderId()

Getter for OrderId. The ID of the order associated with the payment link.

Returns:

Returns the String

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

getUrl

public String getUrl()

Getter for Url. The URL of the payment link.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp when the payment link was created, in RFC 3339 format.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The timestamp when the payment link was last updated, in RFC 3339 format.

Returns:

Returns the String

getPaymentNote

public String getPaymentNote()

Getter for PaymentNote. An optional note. After Square processes the payment, this note is added 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 PaymentLink into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PaymentLink.Builder toBuilder()

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

Returns:

a new PaymentLink.Builder object