pub struct Payout {Show 22 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: Option<Metadata>,
pub method: String,
pub original_payout: Option<Expandable<Payout>>,
pub reconciliation_status: PayoutReconciliationStatus,
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
The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
arrival_date: Timestamp
Date that you can expect the payout to arrive in the bank.
This factors in delays to account for weekends or bank holidays.
automatic: bool
Returns true
if the payout is created by an automated payout schedule and false
if it’s 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 is sent to.
failure_balance_transaction: Option<Expandable<BalanceTransaction>>
If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.
failure_code: Option<String>
Error code that provides a reason for a payout failure, if available.
View our list of failure codes.
failure_message: Option<String>
Message that provides the reason for a 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: Option<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 supported for payouts to debit cards and bank accounts in certain countries.
Learn more about bank support for Instant Payouts.
original_payout: Option<Expandable<Payout>>
If the payout reverses another, this is the ID of the original payout.
reconciliation_status: PayoutReconciliationStatus
If completed
, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.
reversed_by: Option<Expandable<Payout>>
If the payout reverses, this is the ID of the payout that reverses this payout.
source_type: String
The source balance this payout came from, which can be one of the following: card
, fpx
, or bank_account
.
statement_descriptor: Option<String>
Extra information about a payout that displays 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’s submitted to the bank, when it becomes in_transit
.
The status changes to paid
if the transaction succeeds, or to failed
or canceled
(within 5 business days).
Some payouts that fail might initially show as paid
, then change to failed
.
type_: PayoutType
Can be bank_account
or card
.
Implementations§
source§impl 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 payouts that Stripe sent to you.
The payouts return 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, create a new payout object.
Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error. If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode. If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.