Struct stripe::Payout

pub struct Payout {
    pub id: PayoutId,
    pub amount: i64,
    pub arrival_date: Timestamp,
    pub automatic: bool,
    pub balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub created: Timestamp,
    pub currency: Currency,
    pub description: Option<String>,
    pub destination: Option<Expandable<PayoutDestination>>,
    pub failure_balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub failure_code: Option<String>,
    pub failure_message: Option<String>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub method: String,
    pub source_type: String,
    pub statement_descriptor: Option<String>,
    pub status: String,
    pub type_: PayoutType,
}

The resource representing a Stripe "Payout".

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

Fields

id: PayoutId

Unique identifier for the object.

amount: i64

Amount (in %s) to be transferred to your bank account or debit card.

arrival_date: Timestamp

Date the payout is expected to arrive in the bank.

This factors in delays like weekends or bank holidays.

automatic: bool

Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.

balance_transaction: Option<Expandable<BalanceTransaction>>

ID of the balance transaction that describes the impact of this payout on your account balance.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Currency

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

description: Option<String>

An arbitrary string attached to the object.

Often useful for displaying to users.

destination: Option<Expandable<PayoutDestination>>

ID of the bank account or card the payout was sent to.

failure_balance_transaction: Option<Expandable<BalanceTransaction>>

If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.

failure_code: Option<String>

Error code explaining reason for payout failure if available.

See Types of payout failures for a list of failure codes.

failure_message: Option<String>

Message to user further explaining reason for payout failure if available.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: Metadata

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format.

method: String

The method used to send this payout, which can be standard or instant.

instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.).

source_type: String

The source balance this payout came from.

One of card or bank_account.

statement_descriptor: Option<String>

Extra information about a payout to be displayed on the user's bank statement.

status: String

Current status of the payout (paid, pending, in_transit, canceled or failed).

A payout will be pending until it is submitted to the bank, at which point it becomes in_transit. It will then change to paid if the transaction goes through. If it does not go through successfully, its status will change to failed or canceled.

type_: PayoutType

Can be bank_account or card.

Methods

impl Payout

pub fn list(client: &Client, params: ListPayouts) -> Response<List<Payout>>

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you.

The payouts are returned in sorted order, with the most recently created payouts appearing first.

pub fn create(client: &Client, params: CreatePayout) -> Response<Payout>

To send funds to your own bank account, you create a new payout object.

Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error. If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode. If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

pub fn retrieve(
    client: &Client,
    id: &PayoutId,
    expand: &[&str]
) -> Response<Payout>

Retrieves the details of an existing payout.

Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

pub fn update(
    client: &Client,
    id: &PayoutId,
    params: UpdatePayout
) -> Response<Payout>

Updates the specified payout by setting the values of the parameters passed.

Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

impl Payout

pub fn cancel(client: &Client, id: &PayoutId) -> Response<Payout>

Cancels the payout.

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

Trait Implementations

impl Object for Payout

type Id = PayoutId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Clone for Payout

fn clone(&self) -> Payout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payout

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

Formats the value using the given formatter.

impl Serialize for Payout

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Payout

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.