com.squareup.square.models

Class ListPaymentsRequest

java.lang.Object

com.squareup.square.models.ListPaymentsRequest

public class ListPaymentsRequest
extends Object

This is a model class for ListPaymentsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListPaymentsRequest(String beginTime, String endTime, String sortOrder, String cursor, String locationId, Long total, String last4, String cardBrand, Integer limit) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBeginTime() Getter for BeginTime.
String	getCardBrand() Getter for CardBrand.
String	getCursor() Getter for Cursor.
String	getEndTime() Getter for EndTime.
String	getLast4() Getter for Last4.
Integer	getLimit() Getter for Limit.
String	getLocationId() Getter for LocationId.
String	getSortOrder() Getter for SortOrder.
Long	getTotal() Getter for Total.
int	hashCode()
ListPaymentsRequest.Builder	toBuilder() Builds a new ListPaymentsRequest.Builder object.
String	toString() Converts this ListPaymentsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPaymentsRequest

public ListPaymentsRequest(String beginTime,
                           String endTime,
                           String sortOrder,
                           String cursor,
                           String locationId,
                           Long total,
                           String last4,
                           String cardBrand,
                           Integer limit)

Initialization constructor.

Parameters:

beginTime - String value for beginTime.

endTime - String value for endTime.

sortOrder - String value for sortOrder.

cursor - String value for cursor.

locationId - String value for locationId.

total - Long value for total.

last4 - String value for last4.

cardBrand - String value for cardBrand.

limit - Integer value for limit.

Method Detail

getBeginTime

public String getBeginTime()

Getter for BeginTime. The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year.

Returns:

Returns the String

getEndTime

public String getEndTime()

Getter for EndTime. The timestamp for the end of the reporting period, in RFC 3339 format. Default: The current time.

Returns:

Returns the String

getSortOrder

public String getSortOrder()

Getter for SortOrder. The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

Returns:

Returns the String

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.

Returns:

Returns the String

getTotal

public Long getTotal()

Getter for Total. The exact amount in the `total_money` for a payment.

Returns:

Returns the Long

getLast4

public String getLast4()

Getter for Last4. The last four digits of a payment card.

Returns:

Returns the String

getCardBrand

public String getCardBrand()

Getter for CardBrand. The brand of the payment card (for example, VISA).

Returns:

Returns the String

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

Returns the Integer

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListPaymentsRequest.Builder toBuilder()

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

Returns:

a new ListPaymentsRequest.Builder object