[−][src]Struct stripe::Payout

pub struct Payout {
    pub id: String,
    pub amount: u64,
    pub arrival_date: Timestamp,
    pub balance_transaction: String,
    pub created: Timestamp,
    pub currency: Currency,
    pub description: Option<String>,
    pub destination: Option<String>,
    pub failure_balance_transaction: Option<String>,
    pub failure_code: Option<PayoutFailureCode>,
    pub failure_message: Option<String>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub method: PayoutMethod,
    pub source_type: PayoutSourceType,
    pub statement_descriptor: Option<String>,
    pub status: PayoutStatus,
    pub payout_type: PayoutType,
}

The resource representing a Stripe payout.

For more details see https://stripe.com/docs/api#payout_object.

Fields

id: Stringamount: u64arrival_date: Timestampbalance_transaction: Stringcreated: Timestampcurrency: Currencydescription: Option<String>destination: Option<String>failure_balance_transaction: Option<String>failure_code: Option<PayoutFailureCode>failure_message: Option<String>livemode: boolmetadata: Metadatamethod: PayoutMethodsource_type: PayoutSourceTypestatement_descriptor: Option<String>status: PayoutStatuspayout_type: PayoutType

Methods

impl Payout[src]

pub fn create(client: &Client, params: PayoutParams) -> Response<Payout>[src]

Creates a new payout.

For more details see https://stripe.com/docs/api/payouts/create.

pub fn retrieve(client: &Client, payout_id: &str) -> Response<Payout>[src]

Retrieves the details of a payout.

For more details see https://stripe.com/docs/api/payouts/retrieve.

pub fn update(
    client: &Client,
    payout_id: &str,
    metadata: Option<Metadata>
) -> Response<Payout>[src]

Updates a payout's properties.

For more details see https://stripe.com/docs/api/payouts/update.

pub fn list(client: &Client, params: PayoutListParams) -> Response<List<Payout>>[src]

List all payouts.

For more details see https://stripe.com/docs/api/payouts/list.

pub fn cancel(client: &Client, payout_id: &str) -> Response<Payout>[src]

Cancels the payout.

For more details see https://stripe.com/docs/api/payouts/cancel.

Trait Implementations

impl Clone for Payout[src]

default fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for Payout[src]

impl Serialize for Payout[src]

impl<'de> Deserialize<'de> for Payout[src]

Auto Trait Implementations

impl Send for Payout

impl Sync for Payout

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, [src]

impl<T> BorrowMut for T where
    T: ?Sized, [src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, [src]

impl<T> Erased for T

impl<T> Same for T

type Output = T

Should always be Self