Struct ListPaymentRefundsParameters

pub struct ListPaymentRefundsParameters {
    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 status: Option<PaymentRefundStatus>,
    pub source_type: Option<PaymentSourceType>,
    pub limit: Option<i32>,
}

This is a model struct for ListPaymentRefundsParameters (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 all locations associated with the seller.

status: Option<PaymentRefundStatus>

If provided, only refunds with the given status are returned.

Default: If omitted, refunds are returned regardless of their status.

source_type: Option<PaymentSourceType>

If provided, only returns refunds whose payments have the indicated source type. Current values include CARD, BANK_ACCOUNT, WALLET, CASH, and EXTERNAL. For information about these payment source types, see Take Payments.

Default: If omitted, refunds are returned regardless of the source type.

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 ListPaymentRefundsParameters

pub fn to_query_string(&self) -> String

Trait Implementations

impl Clone for ListPaymentRefundsParameters

fn clone(&self) -> ListPaymentRefundsParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListPaymentRefundsParameters

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

Formats the value using the given formatter.

impl Default for ListPaymentRefundsParameters

fn default() -> ListPaymentRefundsParameters

Returns the “default value” for a type.

impl From<ListPaymentRefundsParameters> for String

fn from(list_payment_refunds_parameters: ListPaymentRefundsParameters) -> Self

Converts to this type from the input type.

impl ToString for ListPaymentRefundsParameters

fn to_string(&self) -> String

Converts the given value to a String.