com.squareup.square.models

Class V1ListPaymentsRequest

java.lang.Object

com.squareup.square.models.V1ListPaymentsRequest

public class V1ListPaymentsRequest
extends Object

This is a model class for V1ListPaymentsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
V1ListPaymentsRequest(String order, String beginTime, String endTime, Integer limit, String batchToken, Boolean includePartial) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBatchToken() Getter for BatchToken.
String	getBeginTime() Getter for BeginTime.
String	getEndTime() Getter for EndTime.
Boolean	getIncludePartial() Getter for IncludePartial.
Integer	getLimit() Getter for Limit.
String	getOrder() Getter for Order.
int	hashCode()
V1ListPaymentsRequest.Builder	toBuilder() Builds a new V1ListPaymentsRequest.Builder object.
String	toString() Converts this V1ListPaymentsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

V1ListPaymentsRequest

public V1ListPaymentsRequest(String order,
                             String beginTime,
                             String endTime,
                             Integer limit,
                             String batchToken,
                             Boolean includePartial)

Initialization constructor.

Parameters:

order - String value for order.

beginTime - String value for beginTime.

endTime - String value for endTime.

limit - Integer value for limit.

batchToken - String value for batchToken.

includePartial - Boolean value for includePartial.

Method Detail

getOrder

public String getOrder()

Getter for Order. The order (e.g., chronological or alphabetical) in which results from a request are returned.

Returns:

Returns the String

getBeginTime

public String getBeginTime()

Getter for BeginTime. The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

Returns:

Returns the String

getEndTime

public String getEndTime()

Getter for EndTime. The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

Returns:

Returns the String

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of payments to return in a single response. This value cannot exceed 200.

Returns:

Returns the Integer

getBatchToken

public String getBatchToken()

Getter for BatchToken. A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Returns:

Returns the String

getIncludePartial

public Boolean getIncludePartial()

Getter for IncludePartial. Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public V1ListPaymentsRequest.Builder toBuilder()

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

Returns:

a new V1ListPaymentsRequest.Builder object