Struct square_api_client::models::ListPaymentsParameters

pub struct ListPaymentsParameters {
    pub begin_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub sort_order: Option<SortOrder>,
    pub cursor: Option<String>,
    pub location_id: Option<String>,
    pub total: Option<i32>,
    pub last_4: Option<String>,
    pub card_brand: Option<String>,
    pub limit: Option<i32>,
}

This is a model struct for ListPaymentsParameters (query parameters)

Fields

begin_time: Option<DateTime>

The timestamp for the beginning of the reporting period. Inclusive.

Default: The current time minus one year.

end_time: Option<DateTime>

The timestamp for the end of the reporting period.

Default: The current time.

sort_order: Option<SortOrder>

The order in which results are listed.

• ASC - Oldest to newest.
• DESC - Newest to oldest (default).

cursor: Option<String>

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.

location_id: Option<String>

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

total: Option<i32>

The exact amount in the total_money for a payment.

last_4: Option<String>

The last four digits of a payment card.

card_brand: Option<String>

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

limit: Option<i32>

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

Implementations

impl ListPaymentsParameters

pub fn to_query_string(&self) -> String

Trait Implementations

impl Clone for ListPaymentsParameters

fn clone(&self) -> ListPaymentsParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListPaymentsParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListPaymentsParameters

fn default() -> ListPaymentsParameters

Returns the “default value” for a type.

impl From<ListPaymentsParameters> for String

fn from(list_payments_parameters: ListPaymentsParameters) -> Self

Converts to this type from the input type.

impl ToString for ListPaymentsParameters

fn to_string(&self) -> String

Converts the given value to a String.