[−][src]Struct stripe::Payout
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
.
Implementations
impl Payout
[src]
pub fn list(client: &Client, params: ListPayouts) -> Response<List<Payout>>
[src]
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>
[src]
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>
[src]
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>
[src]
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
[src]
pub fn cancel(client: &Client, id: &PayoutId) -> Response<Payout>
[src]
Cancels the payout.
For more details see https://stripe.com/docs/api/payouts/cancel.
Trait Implementations
impl Clone for Payout
[src]
impl Debug for Payout
[src]
impl<'de> Deserialize<'de> for Payout
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for Payout
[src]
type Id = PayoutId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for Payout
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,