Struct Transfer

pub struct Transfer {

    pub amount: i64,
    pub amount_reversed: i64,
    pub balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub created: i64,
    pub currency: Currency,
    pub description: Option<String>,
    pub destination: Option<Expandable<Account>>,
    pub destination_payment: Option<Expandable<Charge>>,
    pub id: TransferId,
    pub livemode: bool,
    pub metadata: HashMap<String, String>,
    pub reversals: List<TransferReversal>,
    pub reversed: bool,
    pub source_transaction: Option<Expandable<Charge>>,
    pub source_type: Option<String>,
    pub transfer_group: Option<String>,
}

A Transfer object is created when you move funds between Stripe accounts as part of Connect.

Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more. information, read about the transfer/payout split.

Related guide: Creating separate charges and transfers.

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

Fields

amount: i64

Amount in cents (or local equivalent) to be transferred.

amount_reversed: i64

Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

balance_transaction: Option<Expandable<BalanceTransaction>>

Balance transaction that describes the impact of this transfer on your account balance.

created: i64

Time that this record of the transfer was first created.

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

ID of the Stripe account the transfer was sent to.

destination_payment: Option<Expandable<Charge>>

If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

id: TransferId

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

reversals: List<TransferReversal>

A list of reversals that have been applied to the transfer.

reversed: bool

Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

source_transaction: Option<Expandable<Charge>>

ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.

source_type: Option<String>

The source balance this transfer came from. One of card, fpx, or bank_account.

transfer_group: Option<String>

A string that identifies this transaction as part of a group. See the Connect documentation for details.

Trait Implementations

impl Clone for Transfer

fn clone(&self) -> Transfer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transfer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deserialize for Transfer

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

The only correct implementation of this method is:

impl Object for Transfer

type Id = TransferId

The canonical id type for this object.

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

The id of the object.

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

The owned id of the object.

impl ObjectDeser for Transfer

type Builder = TransferBuilder