pub struct Payout {Show 21 fields
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<PayoutDestinationUnion>>,
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 original_payout: Option<Expandable<Payout>>,
pub reversed_by: Option<Expandable<Payout>>,
pub source_type: String,
pub statement_descriptor: Option<String>,
pub status: String,
pub type_: PayoutType,
}
Expand description
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<PayoutDestinationUnion>>
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.).
original_payout: Option<Expandable<Payout>>
If the payout reverses another, this is the ID of the original payout.
reversed_by: Option<Expandable<Payout>>
If the payout was reversed, this is the ID of the payout that reverses this payout.
source_type: String
The source balance this payout came from.
One of card
, fpx
, 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 is pending
until it is submitted to the bank, when it becomes in_transit
.
The status then changes to paid
if the transaction goes through, or to failed
or canceled
(within 5 business days).
Some failed payouts may initially show as paid
but then change to failed
.
type_: PayoutType
Can be bank_account
or card
.
Implementations
sourceimpl Payout
impl Payout
sourcepub fn list(client: &Client, params: &ListPayouts<'_>) -> Response<List<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.
sourcepub fn create(client: &Client, params: CreatePayout<'_>) -> Response<Payout>
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.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Payout
impl<'de> Deserialize<'de> for Payout
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for Payout
impl Send for Payout
impl Sync for Payout
impl Unpin for Payout
impl UnwindSafe for Payout
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more