Struct ListPayout

pub struct ListPayout { /* private fields */ }

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

Implementations

impl ListPayout

pub fn new() -> Self

Construct a new ListPayout.

pub fn arrival_date(self, arrival_date: impl Into<RangeQueryTs>) -> Self

Only return payouts that are expected to arrive during the given date interval.

pub fn created(self, created: impl Into<RangeQueryTs>) -> Self

Only return payouts that were created during the given date interval.

pub fn destination(self, destination: impl Into<String>) -> Self

The ID of an external account - only return payouts sent to this external account.

pub fn ending_before(self, ending_before: impl Into<String>) -> Self

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn limit(self, limit: impl Into<i64>) -> Self

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

pub fn starting_after(self, starting_after: impl Into<String>) -> Self

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

pub fn status(self, status: impl Into<String>) -> Self

Only return payouts that have the given status: pending, paid, failed, or canceled.

impl ListPayout

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

pub fn paginate(&self) -> ListPaginator<List<Payout>>

Trait Implementations

impl Clone for ListPayout

fn clone(&self) -> ListPayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListPayout

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

Formats the value using the given formatter.

impl Default for ListPayout

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for ListPayout

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for ListPayout

type Output = List<Payout>

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.