Struct Payout

pub struct Payout {

    pub amount: i64,
    pub application_fee: Option<Expandable<ApplicationFee>>,
    pub application_fee_amount: Option<i64>,
    pub arrival_date: i64,
    pub automatic: bool,
    pub balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub created: i64,
    pub currency: Currency,
    pub description: Option<String>,
    pub destination: Option<Expandable<ExternalAccount>>,
    pub failure_balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub failure_code: Option<String>,
    pub failure_message: Option<String>,
    pub id: PayoutId,
    pub livemode: bool,
    pub metadata: Option<HashMap<String, String>>,
    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 trace_id: Option<PayoutsTraceId>,
    pub type_: PayoutType,
}

A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.

Related guide: Receiving payouts

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

Fields

amount: i64

The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.

application_fee: Option<Expandable<ApplicationFee>>

The application fee (if any) for the payout. See the Connect documentation for details.

application_fee_amount: Option<i64>

The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.

arrival_date: i64

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: i64

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<ExternalAccount>>

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.

id: PayoutId

Unique identifier for the object.

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<HashMap<String, String>>

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.

trace_id: Option<PayoutsTraceId>

A value that generates from the beneficiary’s bank that allows users to track payouts with their bank. Banks might call this a “reference number” or something similar.

type_: PayoutType

Can be bank_account or card.

Trait Implementations

impl Clone for Payout

fn clone(&self) -> Payout

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Deserialize for Payout

fn begin(out: &mut Option<Payout>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl Object for Payout

type Id = PayoutId

The canonical id type for this object.

fn id(&self) -> &<Payout as Object>::Id

The id of the object.

fn into_id(self) -> <Payout as Object>::Id

The owned id of the object.

impl ObjectDeser for Payout

type Builder = PayoutBuilder